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
23 use MediaWiki\MediaWikiServices
;
24 use MediaWiki\Session\SessionManager
;
25 use MediaWiki\Session\Token
;
26 use MediaWiki\Auth\AuthManager
;
27 use MediaWiki\Auth\AuthenticationResponse
;
28 use MediaWiki\Auth\AuthenticationRequest
;
29 use MediaWiki\User\UserIdentity
;
31 use Wikimedia\ScopedCallback
;
32 use Wikimedia\Rdbms\Database
;
33 use Wikimedia\Rdbms\DBExpectedError
;
34 use Wikimedia\Rdbms\IDatabase
;
37 * String Some punctuation to prevent editing from broken text-mangling proxies.
38 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
41 define( 'EDIT_TOKEN_SUFFIX', Token
::SUFFIX
);
44 * The User object encapsulates all of the user-specific settings (user_id,
45 * name, rights, email address, options, last login time). Client
46 * classes use the getXXX() functions to access these fields. These functions
47 * do all the work of determining whether the user is logged in,
48 * whether the requested option can be satisfied from cookies or
49 * whether a database query is needed. Most of the settings needed
50 * for rendering normal pages are set in the cookie to minimize use
53 class User
implements IDBAccessObject
, UserIdentity
{
55 * @const int Number of characters in user_token field.
57 const TOKEN_LENGTH
= 32;
60 * @const string An invalid value for user_token
62 const INVALID_TOKEN
= '*** INVALID ***';
65 * Global constant made accessible as class constants so that autoloader
67 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
69 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
72 * @const int Serialized record version.
77 * Exclude user options that are set to their default value.
80 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
85 const CHECK_USER_RIGHTS
= true;
90 const IGNORE_USER_RIGHTS
= false;
93 * Array of Strings List of member variables which are saved to the
94 * shared cache (memcached). Any operation which changes the
95 * corresponding database fields must call a cache-clearing function.
98 protected static $mCacheVars = [
106 'mEmailAuthenticated',
108 'mEmailTokenExpires',
113 // user_properties table
120 * Array of Strings Core rights.
121 * Each of these should have a corresponding message of the form
125 protected static $mCoreRights = [
168 'move-categorypages',
169 'move-rootuserpages',
173 'override-export-depth',
195 'userrights-interwiki',
203 * String Cached results of getAllRights()
205 protected static $mAllRights = false;
207 /** Cache variables */
220 /** @var string TS_MW timestamp from the DB */
222 /** @var string TS_MW timestamp from cache */
223 protected $mQuickTouched;
227 public $mEmailAuthenticated;
229 protected $mEmailToken;
231 protected $mEmailTokenExpires;
233 protected $mRegistration;
235 protected $mEditCount;
236 /** @var UserGroupMembership[] Associative array of (group name => UserGroupMembership object) */
237 protected $mGroupMemberships;
239 protected $mOptionOverrides;
243 * Bool Whether the cache variables have been loaded.
246 public $mOptionsLoaded;
249 * Array with already loaded items or true if all items have been loaded.
251 protected $mLoadedItems = [];
255 * String Initialization data source if mLoadedItems!==true. May be one of:
256 * - 'defaults' anonymous user initialised from class defaults
257 * - 'name' initialise from mName
258 * - 'id' initialise from mId
259 * - 'actor' initialise from mActorId
260 * - 'session' log in from session if possible
262 * Use the User::newFrom*() family of functions to set this.
267 * Lazy-initialized variables, invalidated with clearInstanceCache
271 protected $mDatePreference;
279 protected $mBlockreason;
281 protected $mEffectiveGroups;
283 protected $mImplicitGroups;
285 protected $mFormerGroups;
287 protected $mGlobalBlock;
295 /** @var WebRequest */
302 protected $mAllowUsertalk;
305 private $mBlockedFromCreateAccount = false;
307 /** @var int User::READ_* constant bitfield used to load data */
308 protected $queryFlagsUsed = self
::READ_NORMAL
;
310 public static $idCacheByName = [];
313 * Lightweight constructor for an anonymous user.
314 * Use the User::newFrom* factory functions for other kinds of users.
318 * @see newFromActorId()
319 * @see newFromConfirmationCode()
320 * @see newFromSession()
323 public function __construct() {
324 $this->clearInstanceCache( 'defaults' );
330 public function __toString() {
331 return (string)$this->getName();
335 * Test if it's safe to load this User object.
337 * You should typically check this before using $wgUser or
338 * RequestContext::getUser in a method that might be called before the
339 * system has been fully initialized. If the object is unsafe, you should
340 * use an anonymous user:
342 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
348 public function isSafeToLoad() {
349 global $wgFullyInitialised;
351 // The user is safe to load if:
352 // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
353 // * mLoadedItems === true (already loaded)
354 // * mFrom !== 'session' (sessions not involved at all)
356 return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
357 $this->mLoadedItems
=== true ||
$this->mFrom
!== 'session';
361 * Load the user table data for this object from the source given by mFrom.
363 * @param int $flags User::READ_* constant bitfield
365 public function load( $flags = self
::READ_NORMAL
) {
366 global $wgFullyInitialised;
368 if ( $this->mLoadedItems
=== true ) {
372 // Set it now to avoid infinite recursion in accessors
373 $oldLoadedItems = $this->mLoadedItems
;
374 $this->mLoadedItems
= true;
375 $this->queryFlagsUsed
= $flags;
377 // If this is called too early, things are likely to break.
378 if ( !$wgFullyInitialised && $this->mFrom
=== 'session' ) {
379 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
380 ->warning( 'User::loadFromSession called before the end of Setup.php', [
381 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
383 $this->loadDefaults();
384 $this->mLoadedItems
= $oldLoadedItems;
388 switch ( $this->mFrom
) {
390 $this->loadDefaults();
393 // Make sure this thread sees its own changes
394 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
395 if ( $lb->hasOrMadeRecentMasterChanges() ) {
396 $flags |
= self
::READ_LATEST
;
397 $this->queryFlagsUsed
= $flags;
400 $this->mId
= self
::idFromName( $this->mName
, $flags );
402 // Nonexistent user placeholder object
403 $this->loadDefaults( $this->mName
);
405 $this->loadFromId( $flags );
409 // Make sure this thread sees its own changes, if the ID isn't 0
410 if ( $this->mId
!= 0 ) {
411 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
412 if ( $lb->hasOrMadeRecentMasterChanges() ) {
413 $flags |
= self
::READ_LATEST
;
414 $this->queryFlagsUsed
= $flags;
418 $this->loadFromId( $flags );
421 // Make sure this thread sees its own changes
422 if ( wfGetLB()->hasOrMadeRecentMasterChanges() ) {
423 $flags |
= self
::READ_LATEST
;
424 $this->queryFlagsUsed
= $flags;
427 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
428 $row = wfGetDB( $index )->selectRow(
430 [ 'actor_user', 'actor_name' ],
431 [ 'actor_id' => $this->mActorId
],
438 $this->loadDefaults();
439 } elseif ( $row->actor_user
) {
440 $this->mId
= $row->actor_user
;
441 $this->loadFromId( $flags );
443 $this->loadDefaults( $row->actor_name
);
447 if ( !$this->loadFromSession() ) {
448 // Loading from session failed. Load defaults.
449 $this->loadDefaults();
451 Hooks
::run( 'UserLoadAfterLoadFromSession', [ $this ] );
454 throw new UnexpectedValueException(
455 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
460 * Load user table data, given mId has already been set.
461 * @param int $flags User::READ_* constant bitfield
462 * @return bool False if the ID does not exist, true otherwise
464 public function loadFromId( $flags = self
::READ_NORMAL
) {
465 if ( $this->mId
== 0 ) {
466 // Anonymous users are not in the database (don't need cache)
467 $this->loadDefaults();
471 // Try cache (unless this needs data from the master DB).
472 // NOTE: if this thread called saveSettings(), the cache was cleared.
473 $latest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
475 if ( !$this->loadFromDatabase( $flags ) ) {
476 // Can't load from ID
480 $this->loadFromCache();
483 $this->mLoadedItems
= true;
484 $this->queryFlagsUsed
= $flags;
491 * @param string $wikiId
494 public static function purge( $wikiId, $userId ) {
495 $cache = ObjectCache
::getMainWANInstance();
496 $key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
497 $cache->delete( $key );
502 * @param WANObjectCache $cache
505 protected function getCacheKey( WANObjectCache
$cache ) {
506 return $cache->makeGlobalKey( 'user', 'id', wfWikiID(), $this->mId
);
510 * @param WANObjectCache $cache
514 public function getMutableCacheKeys( WANObjectCache
$cache ) {
515 $id = $this->getId();
517 return $id ?
[ $this->getCacheKey( $cache ) ] : [];
521 * Load user data from shared cache, given mId has already been set.
526 protected function loadFromCache() {
527 $cache = ObjectCache
::getMainWANInstance();
528 $data = $cache->getWithSetCallback(
529 $this->getCacheKey( $cache ),
531 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
532 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
533 wfDebug( "User: cache miss for user {$this->mId}\n" );
535 $this->loadFromDatabase( self
::READ_NORMAL
);
537 $this->loadOptions();
540 foreach ( self
::$mCacheVars as $name ) {
541 $data[$name] = $this->$name;
544 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->mTouched
), $ttl );
546 // if a user group membership is about to expire, the cache needs to
547 // expire at that time (T163691)
548 foreach ( $this->mGroupMemberships
as $ugm ) {
549 if ( $ugm->getExpiry() ) {
550 $secondsUntilExpiry = wfTimestamp( TS_UNIX
, $ugm->getExpiry() ) - time();
551 if ( $secondsUntilExpiry > 0 && $secondsUntilExpiry < $ttl ) {
552 $ttl = $secondsUntilExpiry;
559 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'version' => self
::VERSION
]
562 // Restore from cache
563 foreach ( self
::$mCacheVars as $name ) {
564 $this->$name = $data[$name];
570 /** @name newFrom*() static factory methods */
574 * Static factory method for creation from username.
576 * This is slightly less efficient than newFromId(), so use newFromId() if
577 * you have both an ID and a name handy.
579 * @param string $name Username, validated by Title::newFromText()
580 * @param string|bool $validate Validate username. Takes the same parameters as
581 * User::getCanonicalName(), except that true is accepted as an alias
582 * for 'valid', for BC.
584 * @return User|bool User object, or false if the username is invalid
585 * (e.g. if it contains illegal characters or is an IP address). If the
586 * username is not present in the database, the result will be a user object
587 * with a name, zero user ID and default settings.
589 public static function newFromName( $name, $validate = 'valid' ) {
590 if ( $validate === true ) {
593 $name = self
::getCanonicalName( $name, $validate );
594 if ( $name === false ) {
597 // Create unloaded user object
601 $u->setItemLoaded( 'name' );
607 * Static factory method for creation from a given user ID.
609 * @param int $id Valid user ID
610 * @return User The corresponding User object
612 public static function newFromId( $id ) {
616 $u->setItemLoaded( 'id' );
621 * Static factory method for creation from a given actor ID.
624 * @param int $id Valid actor ID
625 * @return User The corresponding User object
627 public static function newFromActorId( $id ) {
628 global $wgActorTableSchemaMigrationStage;
630 if ( $wgActorTableSchemaMigrationStage <= MIGRATION_OLD
) {
631 throw new BadMethodCallException(
632 'Cannot use ' . __METHOD__
. ' when $wgActorTableSchemaMigrationStage is MIGRATION_OLD'
639 $u->setItemLoaded( 'actor' );
644 * Static factory method for creation from an ID, name, and/or actor ID
646 * This does not check that the ID, name, and actor ID all correspond to
650 * @param int|null $userId User ID, if known
651 * @param string|null $userName User name, if known
652 * @param int|null $actorId Actor ID, if known
655 public static function newFromAnyId( $userId, $userName, $actorId ) {
656 global $wgActorTableSchemaMigrationStage;
659 $user->mFrom
= 'defaults';
661 if ( $wgActorTableSchemaMigrationStage > MIGRATION_OLD
&& $actorId !== null ) {
662 $user->mActorId
= (int)$actorId;
663 if ( $user->mActorId
!== 0 ) {
664 $user->mFrom
= 'actor';
666 $user->setItemLoaded( 'actor' );
669 if ( $userName !== null && $userName !== '' ) {
670 $user->mName
= $userName;
671 $user->mFrom
= 'name';
672 $user->setItemLoaded( 'name' );
675 if ( $userId !== null ) {
676 $user->mId
= (int)$userId;
677 if ( $user->mId
!== 0 ) {
680 $user->setItemLoaded( 'id' );
683 if ( $user->mFrom
=== 'defaults' ) {
684 throw new InvalidArgumentException(
685 'Cannot create a user with no name, no ID, and no actor ID'
693 * Factory method to fetch whichever user has a given email confirmation code.
694 * This code is generated when an account is created or its e-mail address
697 * If the code is invalid or has expired, returns NULL.
699 * @param string $code Confirmation code
700 * @param int $flags User::READ_* bitfield
703 public static function newFromConfirmationCode( $code, $flags = 0 ) {
704 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
705 ?
wfGetDB( DB_MASTER
)
706 : wfGetDB( DB_REPLICA
);
708 $id = $db->selectField(
712 'user_email_token' => md5( $code ),
713 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
717 return $id ? self
::newFromId( $id ) : null;
721 * Create a new user object using data from session. If the login
722 * credentials are invalid, the result is an anonymous user.
724 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
727 public static function newFromSession( WebRequest
$request = null ) {
729 $user->mFrom
= 'session';
730 $user->mRequest
= $request;
735 * Create a new user object from a user row.
736 * The row should have the following fields from the user table in it:
737 * - either user_name or user_id to load further data if needed (or both)
739 * - all other fields (email, etc.)
740 * It is useless to provide the remaining fields if either user_id,
741 * user_name and user_real_name are not provided because the whole row
742 * will be loaded once more from the database when accessing them.
744 * @param stdClass $row A row from the user table
745 * @param array $data Further data to load into the object (see User::loadFromRow for valid keys)
748 public static function newFromRow( $row, $data = null ) {
750 $user->loadFromRow( $row, $data );
755 * Static factory method for creation of a "system" user from username.
757 * A "system" user is an account that's used to attribute logged actions
758 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
759 * might include the 'Maintenance script' or 'Conversion script' accounts
760 * used by various scripts in the maintenance/ directory or accounts such
761 * as 'MediaWiki message delivery' used by the MassMessage extension.
763 * This can optionally create the user if it doesn't exist, and "steal" the
764 * account if it does exist.
766 * "Stealing" an existing user is intended to make it impossible for normal
767 * authentication processes to use the account, effectively disabling the
768 * account for normal use:
769 * - Email is invalidated, to prevent account recovery by emailing a
770 * temporary password and to disassociate the account from the existing
772 * - The token is set to a magic invalid value, to kill existing sessions
773 * and to prevent $this->setToken() calls from resetting the token to a
775 * - SessionManager is instructed to prevent new sessions for the user, to
776 * do things like deauthorizing OAuth consumers.
777 * - AuthManager is instructed to revoke access, to invalidate or remove
778 * passwords and other credentials.
780 * @param string $name Username
781 * @param array $options Options are:
782 * - validate: As for User::getCanonicalName(), default 'valid'
783 * - create: Whether to create the user if it doesn't already exist, default true
784 * - steal: Whether to "disable" the account for normal use if it already
785 * exists, default false
789 public static function newSystemUser( $name, $options = [] ) {
791 'validate' => 'valid',
796 $name = self
::getCanonicalName( $name, $options['validate'] );
797 if ( $name === false ) {
801 $dbr = wfGetDB( DB_REPLICA
);
802 $userQuery = self
::getQueryInfo();
803 $row = $dbr->selectRow(
804 $userQuery['tables'],
805 $userQuery['fields'],
806 [ 'user_name' => $name ],
812 // Try the master database...
813 $dbw = wfGetDB( DB_MASTER
);
814 $row = $dbw->selectRow(
815 $userQuery['tables'],
816 $userQuery['fields'],
817 [ 'user_name' => $name ],
825 // No user. Create it?
826 return $options['create']
827 ? self
::createNew( $name, [ 'token' => self
::INVALID_TOKEN
] )
831 $user = self
::newFromRow( $row );
833 // A user is considered to exist as a non-system user if it can
834 // authenticate, or has an email set, or has a non-invalid token.
835 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
836 AuthManager
::singleton()->userCanAuthenticate( $name )
838 // User exists. Steal it?
839 if ( !$options['steal'] ) {
843 AuthManager
::singleton()->revokeAccessForUser( $name );
845 $user->invalidateEmail();
846 $user->mToken
= self
::INVALID_TOKEN
;
847 $user->saveSettings();
848 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
857 * Get the username corresponding to a given user ID
858 * @param int $id User ID
859 * @return string|bool The corresponding username
861 public static function whoIs( $id ) {
862 return UserCache
::singleton()->getProp( $id, 'name' );
866 * Get the real name of a user given their user ID
868 * @param int $id User ID
869 * @return string|bool The corresponding user's real name
871 public static function whoIsReal( $id ) {
872 return UserCache
::singleton()->getProp( $id, 'real_name' );
876 * Get database id given a user name
877 * @param string $name Username
878 * @param int $flags User::READ_* constant bitfield
879 * @return int|null The corresponding user's ID, or null if user is nonexistent
881 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
882 $nt = Title
::makeTitleSafe( NS_USER
, $name );
883 if ( is_null( $nt ) ) {
888 if ( !( $flags & self
::READ_LATEST
) && isset( self
::$idCacheByName[$name] ) ) {
889 return self
::$idCacheByName[$name];
892 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
893 $db = wfGetDB( $index );
898 [ 'user_name' => $nt->getText() ],
903 if ( $s === false ) {
906 $result = $s->user_id
;
909 self
::$idCacheByName[$name] = $result;
911 if ( count( self
::$idCacheByName ) > 1000 ) {
912 self
::$idCacheByName = [];
919 * Reset the cache used in idFromName(). For use in tests.
921 public static function resetIdByNameCache() {
922 self
::$idCacheByName = [];
926 * Does the string match an anonymous IP address?
928 * This function exists for username validation, in order to reject
929 * usernames which are similar in form to IP addresses. Strings such
930 * as 300.300.300.300 will return true because it looks like an IP
931 * address, despite not being strictly valid.
933 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
934 * address because the usemod software would "cloak" anonymous IP
935 * addresses like this, if we allowed accounts like this to be created
936 * new users could get the old edits of these anonymous users.
938 * @param string $name Name to match
941 public static function isIP( $name ) {
942 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
943 || IP
::isIPv6( $name );
947 * Is the user an IP range?
952 public function isIPRange() {
953 return IP
::isValidRange( $this->mName
);
957 * Is the input a valid username?
959 * Checks if the input is a valid username, we don't want an empty string,
960 * an IP address, anything that contains slashes (would mess up subpages),
961 * is longer than the maximum allowed username size or doesn't begin with
964 * @param string $name Name to match
967 public static function isValidUserName( $name ) {
968 global $wgContLang, $wgMaxNameChars;
971 || self
::isIP( $name )
972 ||
strpos( $name, '/' ) !== false
973 ||
strlen( $name ) > $wgMaxNameChars
974 ||
$name != $wgContLang->ucfirst( $name )
979 // Ensure that the name can't be misresolved as a different title,
980 // such as with extra namespace keys at the start.
981 $parsed = Title
::newFromText( $name );
982 if ( is_null( $parsed )
983 ||
$parsed->getNamespace()
984 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
988 // Check an additional blacklist of troublemaker characters.
989 // Should these be merged into the title char list?
990 $unicodeBlacklist = '/[' .
991 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
992 '\x{00a0}' . # non-breaking space
993 '\x{2000}-\x{200f}' . # various whitespace
994 '\x{2028}-\x{202f}' . # breaks and control chars
995 '\x{3000}' . # ideographic space
996 '\x{e000}-\x{f8ff}' . # private use
998 if ( preg_match( $unicodeBlacklist, $name ) ) {
1006 * Usernames which fail to pass this function will be blocked
1007 * from user login and new account registrations, but may be used
1008 * internally by batch processes.
1010 * If an account already exists in this form, login will be blocked
1011 * by a failure to pass this function.
1013 * @param string $name Name to match
1016 public static function isUsableName( $name ) {
1017 global $wgReservedUsernames;
1018 // Must be a valid username, obviously ;)
1019 if ( !self
::isValidUserName( $name ) ) {
1023 static $reservedUsernames = false;
1024 if ( !$reservedUsernames ) {
1025 $reservedUsernames = $wgReservedUsernames;
1026 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
1029 // Certain names may be reserved for batch processes.
1030 foreach ( $reservedUsernames as $reserved ) {
1031 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
1032 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
1034 if ( $reserved == $name ) {
1042 * Return the users who are members of the given group(s). In case of multiple groups,
1043 * users who are members of at least one of them are returned.
1045 * @param string|array $groups A single group name or an array of group names
1046 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
1047 * records; larger values are ignored.
1048 * @param int $after ID the user to start after
1049 * @return UserArrayFromResult
1051 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
1052 if ( $groups === [] ) {
1053 return UserArrayFromResult
::newFromIDs( [] );
1056 $groups = array_unique( (array)$groups );
1057 $limit = min( 5000, $limit );
1059 $conds = [ 'ug_group' => $groups ];
1060 if ( $after !== null ) {
1061 $conds[] = 'ug_user > ' . (int)$after;
1064 $dbr = wfGetDB( DB_REPLICA
);
1065 $ids = $dbr->selectFieldValues(
1072 'ORDER BY' => 'ug_user',
1076 return UserArray
::newFromIDs( $ids );
1080 * Usernames which fail to pass this function will be blocked
1081 * from new account registrations, but may be used internally
1082 * either by batch processes or by user accounts which have
1083 * already been created.
1085 * Additional blacklisting may be added here rather than in
1086 * isValidUserName() to avoid disrupting existing accounts.
1088 * @param string $name String to match
1091 public static function isCreatableName( $name ) {
1092 global $wgInvalidUsernameCharacters;
1094 // Ensure that the username isn't longer than 235 bytes, so that
1095 // (at least for the builtin skins) user javascript and css files
1096 // will work. (T25080)
1097 if ( strlen( $name ) > 235 ) {
1098 wfDebugLog( 'username', __METHOD__
.
1099 ": '$name' invalid due to length" );
1103 // Preg yells if you try to give it an empty string
1104 if ( $wgInvalidUsernameCharacters !== '' ) {
1105 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
1106 wfDebugLog( 'username', __METHOD__
.
1107 ": '$name' invalid due to wgInvalidUsernameCharacters" );
1112 return self
::isUsableName( $name );
1116 * Is the input a valid password for this user?
1118 * @param string $password Desired password
1121 public function isValidPassword( $password ) {
1122 // simple boolean wrapper for getPasswordValidity
1123 return $this->getPasswordValidity( $password ) === true;
1127 * Given unvalidated password input, return error message on failure.
1129 * @param string $password Desired password
1130 * @return bool|string|array True on success, string or array of error message on failure
1132 public function getPasswordValidity( $password ) {
1133 $result = $this->checkPasswordValidity( $password );
1134 if ( $result->isGood() ) {
1138 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
1139 $messages[] = $error['message'];
1141 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
1142 $messages[] = $warning['message'];
1144 if ( count( $messages ) === 1 ) {
1145 return $messages[0];
1152 * Check if this is a valid password for this user
1154 * Create a Status object based on the password's validity.
1155 * The Status should be set to fatal if the user should not
1156 * be allowed to log in, and should have any errors that
1157 * would block changing the password.
1159 * If the return value of this is not OK, the password
1160 * should not be checked. If the return value is not Good,
1161 * the password can be checked, but the user should not be
1162 * able to set their password to this.
1164 * @param string $password Desired password
1168 public function checkPasswordValidity( $password ) {
1169 global $wgPasswordPolicy;
1171 $upp = new UserPasswordPolicy(
1172 $wgPasswordPolicy['policies'],
1173 $wgPasswordPolicy['checks']
1176 $status = Status
::newGood();
1177 $result = false; // init $result to false for the internal checks
1179 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1180 $status->error( $result );
1184 if ( $result === false ) {
1185 $status->merge( $upp->checkUserPassword( $this, $password ) );
1187 } elseif ( $result === true ) {
1190 $status->error( $result );
1191 return $status; // the isValidPassword hook set a string $result and returned true
1196 * Given unvalidated user input, return a canonical username, or false if
1197 * the username is invalid.
1198 * @param string $name User input
1199 * @param string|bool $validate Type of validation to use:
1200 * - false No validation
1201 * - 'valid' Valid for batch processes
1202 * - 'usable' Valid for batch processes and login
1203 * - 'creatable' Valid for batch processes, login and account creation
1205 * @throws InvalidArgumentException
1206 * @return bool|string
1208 public static function getCanonicalName( $name, $validate = 'valid' ) {
1209 // Force usernames to capital
1211 $name = $wgContLang->ucfirst( $name );
1213 # Reject names containing '#'; these will be cleaned up
1214 # with title normalisation, but then it's too late to
1216 if ( strpos( $name, '#' ) !== false ) {
1220 // Clean up name according to title rules,
1221 // but only when validation is requested (T14654)
1222 $t = ( $validate !== false ) ?
1223 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1224 // Check for invalid titles
1225 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1229 // Reject various classes of invalid names
1230 $name = AuthManager
::callLegacyAuthPlugin(
1231 'getCanonicalName', [ $t->getText() ], $t->getText()
1234 switch ( $validate ) {
1238 if ( !self
::isValidUserName( $name ) ) {
1243 if ( !self
::isUsableName( $name ) ) {
1248 if ( !self
::isCreatableName( $name ) ) {
1253 throw new InvalidArgumentException(
1254 'Invalid parameter value for $validate in ' . __METHOD__
);
1260 * Return a random password.
1262 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1263 * @return string New random password
1265 public static function randomPassword() {
1266 global $wgMinimalPasswordLength;
1267 return PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1271 * Set cached properties to default.
1273 * @note This no longer clears uncached lazy-initialised properties;
1274 * the constructor does that instead.
1276 * @param string|bool $name
1278 public function loadDefaults( $name = false ) {
1280 $this->mName
= $name;
1281 $this->mActorId
= null;
1282 $this->mRealName
= '';
1284 $this->mOptionOverrides
= null;
1285 $this->mOptionsLoaded
= false;
1287 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1288 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1289 if ( $loggedOut !== 0 ) {
1290 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1292 $this->mTouched
= '1'; # Allow any pages to be cached
1295 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1296 $this->mEmailAuthenticated
= null;
1297 $this->mEmailToken
= '';
1298 $this->mEmailTokenExpires
= null;
1299 $this->mRegistration
= wfTimestamp( TS_MW
);
1300 $this->mGroupMemberships
= [];
1302 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1306 * Return whether an item has been loaded.
1308 * @param string $item Item to check. Current possibilities:
1312 * @param string $all 'all' to check if the whole object has been loaded
1313 * or any other string to check if only the item is available (e.g.
1317 public function isItemLoaded( $item, $all = 'all' ) {
1318 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1319 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1323 * Set that an item has been loaded
1325 * @param string $item
1327 protected function setItemLoaded( $item ) {
1328 if ( is_array( $this->mLoadedItems
) ) {
1329 $this->mLoadedItems
[$item] = true;
1334 * Load user data from the session.
1336 * @return bool True if the user is logged in, false otherwise.
1338 private function loadFromSession() {
1341 Hooks
::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1342 if ( $result !== null ) {
1346 // MediaWiki\Session\Session already did the necessary authentication of the user
1347 // returned here, so just use it if applicable.
1348 $session = $this->getRequest()->getSession();
1349 $user = $session->getUser();
1350 if ( $user->isLoggedIn() ) {
1351 $this->loadFromUserObject( $user );
1353 // If this user is autoblocked, set a cookie to track the Block. This has to be done on
1354 // every session load, because an autoblocked editor might not edit again from the same
1355 // IP address after being blocked.
1356 $config = RequestContext
::getMain()->getConfig();
1357 if ( $config->get( 'CookieSetOnAutoblock' ) === true ) {
1358 $block = $this->getBlock();
1359 $shouldSetCookie = $this->getRequest()->getCookie( 'BlockID' ) === null
1361 && $block->getType() === Block
::TYPE_USER
1362 && $block->isAutoblocking();
1363 if ( $shouldSetCookie ) {
1364 wfDebug( __METHOD__
. ': User is autoblocked, setting cookie to track' );
1365 $block->setCookie( $this->getRequest()->response() );
1369 // Other code expects these to be set in the session, so set them.
1370 $session->set( 'wsUserID', $this->getId() );
1371 $session->set( 'wsUserName', $this->getName() );
1372 $session->set( 'wsToken', $this->getToken() );
1379 * Load user and user_group data from the database.
1380 * $this->mId must be set, this is how the user is identified.
1382 * @param int $flags User::READ_* constant bitfield
1383 * @return bool True if the user exists, false if the user is anonymous
1385 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1387 $this->mId
= intval( $this->mId
);
1389 if ( !$this->mId
) {
1390 // Anonymous users are not in the database
1391 $this->loadDefaults();
1395 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1396 $db = wfGetDB( $index );
1398 $userQuery = self
::getQueryInfo();
1399 $s = $db->selectRow(
1400 $userQuery['tables'],
1401 $userQuery['fields'],
1402 [ 'user_id' => $this->mId
],
1408 $this->queryFlagsUsed
= $flags;
1409 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1411 if ( $s !== false ) {
1412 // Initialise user table data
1413 $this->loadFromRow( $s );
1414 $this->mGroupMemberships
= null; // deferred
1415 $this->getEditCount(); // revalidation for nulls
1420 $this->loadDefaults();
1426 * Initialize this object from a row from the user table.
1428 * @param stdClass $row Row from the user table to load.
1429 * @param array $data Further user data to load into the object
1431 * user_groups Array of arrays or stdClass result rows out of the user_groups
1432 * table. Previously you were supposed to pass an array of strings
1433 * here, but we also need expiry info nowadays, so an array of
1434 * strings is ignored.
1435 * user_properties Array with properties out of the user_properties table
1437 protected function loadFromRow( $row, $data = null ) {
1438 global $wgActorTableSchemaMigrationStage;
1440 if ( !is_object( $row ) ) {
1441 throw new InvalidArgumentException( '$row must be an object' );
1446 $this->mGroupMemberships
= null; // deferred
1448 if ( $wgActorTableSchemaMigrationStage > MIGRATION_OLD
) {
1449 if ( isset( $row->actor_id
) ) {
1450 $this->mActorId
= (int)$row->actor_id
;
1451 if ( $this->mActorId
!== 0 ) {
1452 $this->mFrom
= 'actor';
1454 $this->setItemLoaded( 'actor' );
1460 if ( isset( $row->user_name
) && $row->user_name
!== '' ) {
1461 $this->mName
= $row->user_name
;
1462 $this->mFrom
= 'name';
1463 $this->setItemLoaded( 'name' );
1468 if ( isset( $row->user_real_name
) ) {
1469 $this->mRealName
= $row->user_real_name
;
1470 $this->setItemLoaded( 'realname' );
1475 if ( isset( $row->user_id
) ) {
1476 $this->mId
= intval( $row->user_id
);
1477 if ( $this->mId
!== 0 ) {
1478 $this->mFrom
= 'id';
1480 $this->setItemLoaded( 'id' );
1485 if ( isset( $row->user_id
) && isset( $row->user_name
) && $row->user_name
!== '' ) {
1486 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1489 if ( isset( $row->user_editcount
) ) {
1490 $this->mEditCount
= $row->user_editcount
;
1495 if ( isset( $row->user_touched
) ) {
1496 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1501 if ( isset( $row->user_token
) ) {
1502 // The definition for the column is binary(32), so trim the NULs
1503 // that appends. The previous definition was char(32), so trim
1505 $this->mToken
= rtrim( $row->user_token
, " \0" );
1506 if ( $this->mToken
=== '' ) {
1507 $this->mToken
= null;
1513 if ( isset( $row->user_email
) ) {
1514 $this->mEmail
= $row->user_email
;
1515 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1516 $this->mEmailToken
= $row->user_email_token
;
1517 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1518 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1524 $this->mLoadedItems
= true;
1527 if ( is_array( $data ) ) {
1528 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1529 if ( !count( $data['user_groups'] ) ) {
1530 $this->mGroupMemberships
= [];
1532 $firstGroup = reset( $data['user_groups'] );
1533 if ( is_array( $firstGroup ) ||
is_object( $firstGroup ) ) {
1534 $this->mGroupMemberships
= [];
1535 foreach ( $data['user_groups'] as $row ) {
1536 $ugm = UserGroupMembership
::newFromRow( (object)$row );
1537 $this->mGroupMemberships
[$ugm->getGroup()] = $ugm;
1542 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1543 $this->loadOptions( $data['user_properties'] );
1549 * Load the data for this user object from another user object.
1553 protected function loadFromUserObject( $user ) {
1555 foreach ( self
::$mCacheVars as $var ) {
1556 $this->$var = $user->$var;
1561 * Load the groups from the database if they aren't already loaded.
1563 private function loadGroups() {
1564 if ( is_null( $this->mGroupMemberships
) ) {
1565 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1566 ?
wfGetDB( DB_MASTER
)
1567 : wfGetDB( DB_REPLICA
);
1568 $this->mGroupMemberships
= UserGroupMembership
::getMembershipsForUser(
1574 * Add the user to the group if he/she meets given criteria.
1576 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1577 * possible to remove manually via Special:UserRights. In such case it
1578 * will not be re-added automatically. The user will also not lose the
1579 * group if they no longer meet the criteria.
1581 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1583 * @return array Array of groups the user has been promoted to.
1585 * @see $wgAutopromoteOnce
1587 public function addAutopromoteOnceGroups( $event ) {
1588 global $wgAutopromoteOnceLogInRC;
1590 if ( wfReadOnly() ||
!$this->getId() ) {
1594 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1595 if ( !count( $toPromote ) ) {
1599 if ( !$this->checkAndSetTouched() ) {
1600 return []; // raced out (bug T48834)
1603 $oldGroups = $this->getGroups(); // previous groups
1604 $oldUGMs = $this->getGroupMemberships();
1605 foreach ( $toPromote as $group ) {
1606 $this->addGroup( $group );
1608 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1609 $newUGMs = $this->getGroupMemberships();
1611 // update groups in external authentication database
1612 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );
1613 AuthManager
::callLegacyAuthPlugin( 'updateExternalDBGroups', [ $this, $toPromote ] );
1615 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1616 $logEntry->setPerformer( $this );
1617 $logEntry->setTarget( $this->getUserPage() );
1618 $logEntry->setParameters( [
1619 '4::oldgroups' => $oldGroups,
1620 '5::newgroups' => $newGroups,
1622 $logid = $logEntry->insert();
1623 if ( $wgAutopromoteOnceLogInRC ) {
1624 $logEntry->publish( $logid );
1631 * Builds update conditions. Additional conditions may be added to $conditions to
1632 * protected against race conditions using a compare-and-set (CAS) mechanism
1633 * based on comparing $this->mTouched with the user_touched field.
1635 * @param Database $db
1636 * @param array $conditions WHERE conditions for use with Database::update
1637 * @return array WHERE conditions for use with Database::update
1639 protected function makeUpdateConditions( Database
$db, array $conditions ) {
1640 if ( $this->mTouched
) {
1641 // CAS check: only update if the row wasn't changed sicne it was loaded.
1642 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1649 * Bump user_touched if it didn't change since this object was loaded
1651 * On success, the mTouched field is updated.
1652 * The user serialization cache is always cleared.
1654 * @return bool Whether user_touched was actually updated
1657 protected function checkAndSetTouched() {
1660 if ( !$this->mId
) {
1661 return false; // anon
1664 // Get a new user_touched that is higher than the old one
1665 $newTouched = $this->newTouchedTimestamp();
1667 $dbw = wfGetDB( DB_MASTER
);
1668 $dbw->update( 'user',
1669 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1670 $this->makeUpdateConditions( $dbw, [
1671 'user_id' => $this->mId
,
1675 $success = ( $dbw->affectedRows() > 0 );
1678 $this->mTouched
= $newTouched;
1679 $this->clearSharedCache();
1681 // Clears on failure too since that is desired if the cache is stale
1682 $this->clearSharedCache( 'refresh' );
1689 * Clear various cached data stored in this object. The cache of the user table
1690 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1692 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1693 * given source. May be "name", "id", "actor", "defaults", "session", or false for no reload.
1695 public function clearInstanceCache( $reloadFrom = false ) {
1696 $this->mNewtalk
= -1;
1697 $this->mDatePreference
= null;
1698 $this->mBlockedby
= -1; # Unset
1699 $this->mHash
= false;
1700 $this->mRights
= null;
1701 $this->mEffectiveGroups
= null;
1702 $this->mImplicitGroups
= null;
1703 $this->mGroupMemberships
= null;
1704 $this->mOptions
= null;
1705 $this->mOptionsLoaded
= false;
1706 $this->mEditCount
= null;
1708 if ( $reloadFrom ) {
1709 $this->mLoadedItems
= [];
1710 $this->mFrom
= $reloadFrom;
1715 * Combine the language default options with any site-specific options
1716 * and add the default language variants.
1718 * @return array Array of String options
1720 public static function getDefaultOptions() {
1721 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1723 static $defOpt = null;
1724 static $defOptLang = null;
1726 if ( $defOpt !== null && $defOptLang === $wgContLang->getCode() ) {
1727 // $wgContLang does not change (and should not change) mid-request,
1728 // but the unit tests change it anyway, and expect this method to
1729 // return values relevant to the current $wgContLang.
1733 $defOpt = $wgDefaultUserOptions;
1734 // Default language setting
1735 $defOptLang = $wgContLang->getCode();
1736 $defOpt['language'] = $defOptLang;
1737 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1738 $defOpt[$langCode == $wgContLang->getCode() ?
'variant' : "variant-$langCode"] = $langCode;
1741 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1742 // since extensions may change the set of searchable namespaces depending
1743 // on user groups/permissions.
1744 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1745 $defOpt['searchNs' . $nsnum] = (bool)$val;
1747 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1749 Hooks
::run( 'UserGetDefaultOptions', [ &$defOpt ] );
1755 * Get a given default option value.
1757 * @param string $opt Name of option to retrieve
1758 * @return string Default option value
1760 public static function getDefaultOption( $opt ) {
1761 $defOpts = self
::getDefaultOptions();
1762 if ( isset( $defOpts[$opt] ) ) {
1763 return $defOpts[$opt];
1770 * Get blocking information
1771 * @param bool $bFromSlave Whether to check the replica DB first.
1772 * To improve performance, non-critical checks are done against replica DBs.
1773 * Check when actually saving should be done against master.
1775 private function getBlockedStatus( $bFromSlave = true ) {
1776 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff, $wgSoftBlockRanges;
1778 if ( -1 != $this->mBlockedby
) {
1782 wfDebug( __METHOD__
. ": checking...\n" );
1784 // Initialize data...
1785 // Otherwise something ends up stomping on $this->mBlockedby when
1786 // things get lazy-loaded later, causing false positive block hits
1787 // due to -1 !== 0. Probably session-related... Nothing should be
1788 // overwriting mBlockedby, surely?
1791 # We only need to worry about passing the IP address to the Block generator if the
1792 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1793 # know which IP address they're actually coming from
1795 if ( !$this->isAllowed( 'ipblock-exempt' ) ) {
1796 // $wgUser->getName() only works after the end of Setup.php. Until
1797 // then, assume it's a logged-out user.
1798 $globalUserName = $wgUser->isSafeToLoad()
1799 ?
$wgUser->getName()
1800 : IP
::sanitizeIP( $wgUser->getRequest()->getIP() );
1801 if ( $this->getName() === $globalUserName ) {
1802 $ip = $this->getRequest()->getIP();
1807 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1810 if ( !$block instanceof Block
) {
1811 $block = $this->getBlockFromCookieValue( $this->getRequest()->getCookie( 'BlockID' ) );
1815 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1817 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1818 $block = new Block( [
1819 'byText' => wfMessage( 'proxyblocker' )->text(),
1820 'reason' => wfMessage( 'proxyblockreason' )->text(),
1822 'systemBlock' => 'proxy',
1824 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1825 $block = new Block( [
1826 'byText' => wfMessage( 'sorbs' )->text(),
1827 'reason' => wfMessage( 'sorbsreason' )->text(),
1829 'systemBlock' => 'dnsbl',
1834 // (T25343) Apply IP blocks to the contents of XFF headers, if enabled
1835 if ( !$block instanceof Block
1836 && $wgApplyIpBlocksToXff
1838 && !in_array( $ip, $wgProxyWhitelist )
1840 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1841 $xff = array_map( 'trim', explode( ',', $xff ) );
1842 $xff = array_diff( $xff, [ $ip ] );
1843 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1844 $block = Block
::chooseBlock( $xffblocks, $xff );
1845 if ( $block instanceof Block
) {
1846 # Mangle the reason to alert the user that the block
1847 # originated from matching the X-Forwarded-For header.
1848 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->text();
1852 if ( !$block instanceof Block
1855 && IP
::isInRanges( $ip, $wgSoftBlockRanges )
1857 $block = new Block( [
1859 'byText' => 'MediaWiki default',
1860 'reason' => wfMessage( 'softblockrangesreason', $ip )->text(),
1862 'systemBlock' => 'wgSoftBlockRanges',
1866 if ( $block instanceof Block
) {
1867 wfDebug( __METHOD__
. ": Found block.\n" );
1868 $this->mBlock
= $block;
1869 $this->mBlockedby
= $block->getByName();
1870 $this->mBlockreason
= $block->mReason
;
1871 $this->mHideName
= $block->mHideName
;
1872 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1874 $this->mBlockedby
= '';
1875 $this->mHideName
= 0;
1876 $this->mAllowUsertalk
= false;
1879 // Avoid PHP 7.1 warning of passing $this by reference
1882 Hooks
::run( 'GetBlockedStatus', [ &$user ] );
1886 * Try to load a Block from an ID given in a cookie value.
1887 * @param string|null $blockCookieVal The cookie value to check.
1888 * @return Block|bool The Block object, or false if none could be loaded.
1890 protected function getBlockFromCookieValue( $blockCookieVal ) {
1891 // Make sure there's something to check. The cookie value must start with a number.
1892 if ( strlen( $blockCookieVal ) < 1 ||
!is_numeric( substr( $blockCookieVal, 0, 1 ) ) ) {
1895 // Load the Block from the ID in the cookie.
1896 $blockCookieId = Block
::getIdFromCookieValue( $blockCookieVal );
1897 if ( $blockCookieId !== null ) {
1898 // An ID was found in the cookie.
1899 $tmpBlock = Block
::newFromID( $blockCookieId );
1900 if ( $tmpBlock instanceof Block
) {
1901 // Check the validity of the block.
1902 $blockIsValid = $tmpBlock->getType() == Block
::TYPE_USER
1903 && !$tmpBlock->isExpired()
1904 && $tmpBlock->isAutoblocking();
1905 $config = RequestContext
::getMain()->getConfig();
1906 $useBlockCookie = ( $config->get( 'CookieSetOnAutoblock' ) === true );
1907 if ( $blockIsValid && $useBlockCookie ) {
1911 // If the block is not valid, remove the cookie.
1912 Block
::clearCookie( $this->getRequest()->response() );
1915 // If the block doesn't exist, remove the cookie.
1916 Block
::clearCookie( $this->getRequest()->response() );
1923 * Whether the given IP is in a DNS blacklist.
1925 * @param string $ip IP to check
1926 * @param bool $checkWhitelist Whether to check the whitelist first
1927 * @return bool True if blacklisted.
1929 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1930 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1932 if ( !$wgEnableDnsBlacklist ) {
1936 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1940 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
1944 * Whether the given IP is in a given DNS blacklist.
1946 * @param string $ip IP to check
1947 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1948 * @return bool True if blacklisted.
1950 public function inDnsBlacklist( $ip, $bases ) {
1952 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
1953 if ( IP
::isIPv4( $ip ) ) {
1954 // Reverse IP, T23255
1955 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1957 foreach ( (array)$bases as $base ) {
1959 // If we have an access key, use that too (ProjectHoneypot, etc.)
1961 if ( is_array( $base ) ) {
1962 if ( count( $base ) >= 2 ) {
1963 // Access key is 1, base URL is 0
1964 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1966 $host = "$ipReversed.{$base[0]}";
1968 $basename = $base[0];
1970 $host = "$ipReversed.$base";
1974 $ipList = gethostbynamel( $host );
1977 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
1981 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
1990 * Check if an IP address is in the local proxy list
1996 public static function isLocallyBlockedProxy( $ip ) {
1997 global $wgProxyList;
1999 if ( !$wgProxyList ) {
2003 if ( !is_array( $wgProxyList ) ) {
2004 // Load values from the specified file
2005 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
2008 $resultProxyList = [];
2009 $deprecatedIPEntries = [];
2011 // backward compatibility: move all ip addresses in keys to values
2012 foreach ( $wgProxyList as $key => $value ) {
2013 $keyIsIP = IP
::isIPAddress( $key );
2014 $valueIsIP = IP
::isIPAddress( $value );
2015 if ( $keyIsIP && !$valueIsIP ) {
2016 $deprecatedIPEntries[] = $key;
2017 $resultProxyList[] = $key;
2018 } elseif ( $keyIsIP && $valueIsIP ) {
2019 $deprecatedIPEntries[] = $key;
2020 $resultProxyList[] = $key;
2021 $resultProxyList[] = $value;
2023 $resultProxyList[] = $value;
2027 if ( $deprecatedIPEntries ) {
2029 'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
2030 implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
2033 $proxyListIPSet = new IPSet( $resultProxyList );
2034 return $proxyListIPSet->match( $ip );
2038 * Is this user subject to rate limiting?
2040 * @return bool True if rate limited
2042 public function isPingLimitable() {
2043 global $wgRateLimitsExcludedIPs;
2044 if ( IP
::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
2045 // No other good way currently to disable rate limits
2046 // for specific IPs. :P
2047 // But this is a crappy hack and should die.
2050 return !$this->isAllowed( 'noratelimit' );
2054 * Primitive rate limits: enforce maximum actions per time period
2055 * to put a brake on flooding.
2057 * The method generates both a generic profiling point and a per action one
2058 * (suffix being "-$action".
2060 * @note When using a shared cache like memcached, IP-address
2061 * last-hit counters will be shared across wikis.
2063 * @param string $action Action to enforce; 'edit' if unspecified
2064 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
2065 * @return bool True if a rate limiter was tripped
2067 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
2068 // Avoid PHP 7.1 warning of passing $this by reference
2070 // Call the 'PingLimiter' hook
2072 if ( !Hooks
::run( 'PingLimiter', [ &$user, $action, &$result, $incrBy ] ) ) {
2076 global $wgRateLimits;
2077 if ( !isset( $wgRateLimits[$action] ) ) {
2081 $limits = array_merge(
2082 [ '&can-bypass' => true ],
2083 $wgRateLimits[$action]
2086 // Some groups shouldn't trigger the ping limiter, ever
2087 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
2092 $id = $this->getId();
2094 $isNewbie = $this->isNewbie();
2095 $cache = ObjectCache
::getLocalClusterInstance();
2099 if ( isset( $limits['anon'] ) ) {
2100 $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
2103 // limits for logged-in users
2104 if ( isset( $limits['user'] ) ) {
2105 $userLimit = $limits['user'];
2107 // limits for newbie logged-in users
2108 if ( $isNewbie && isset( $limits['newbie'] ) ) {
2109 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
2113 // limits for anons and for newbie logged-in users
2116 if ( isset( $limits['ip'] ) ) {
2117 $ip = $this->getRequest()->getIP();
2118 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
2120 // subnet-based limits
2121 if ( isset( $limits['subnet'] ) ) {
2122 $ip = $this->getRequest()->getIP();
2123 $subnet = IP
::getSubnet( $ip );
2124 if ( $subnet !== false ) {
2125 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
2130 // Check for group-specific permissions
2131 // If more than one group applies, use the group with the highest limit ratio (max/period)
2132 foreach ( $this->getGroups() as $group ) {
2133 if ( isset( $limits[$group] ) ) {
2134 if ( $userLimit === false
2135 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
2137 $userLimit = $limits[$group];
2142 // Set the user limit key
2143 if ( $userLimit !== false ) {
2144 list( $max, $period ) = $userLimit;
2145 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
2146 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
2149 // ip-based limits for all ping-limitable users
2150 if ( isset( $limits['ip-all'] ) ) {
2151 $ip = $this->getRequest()->getIP();
2152 // ignore if user limit is more permissive
2153 if ( $isNewbie ||
$userLimit === false
2154 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
2155 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
2159 // subnet-based limits for all ping-limitable users
2160 if ( isset( $limits['subnet-all'] ) ) {
2161 $ip = $this->getRequest()->getIP();
2162 $subnet = IP
::getSubnet( $ip );
2163 if ( $subnet !== false ) {
2164 // ignore if user limit is more permissive
2165 if ( $isNewbie ||
$userLimit === false
2166 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
2167 > $userLimit[0] / $userLimit[1] ) {
2168 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
2174 foreach ( $keys as $key => $limit ) {
2175 list( $max, $period ) = $limit;
2176 $summary = "(limit $max in {$period}s)";
2177 $count = $cache->get( $key );
2180 if ( $count >= $max ) {
2181 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
2182 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
2185 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
2188 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
2189 if ( $incrBy > 0 ) {
2190 $cache->add( $key, 0, intval( $period ) ); // first ping
2193 if ( $incrBy > 0 ) {
2194 $cache->incr( $key, $incrBy );
2202 * Check if user is blocked
2204 * @param bool $bFromSlave Whether to check the replica DB instead of
2205 * the master. Hacked from false due to horrible probs on site.
2206 * @return bool True if blocked, false otherwise
2208 public function isBlocked( $bFromSlave = true ) {
2209 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
2213 * Get the block affecting the user, or null if the user is not blocked
2215 * @param bool $bFromSlave Whether to check the replica DB instead of the master
2216 * @return Block|null
2218 public function getBlock( $bFromSlave = true ) {
2219 $this->getBlockedStatus( $bFromSlave );
2220 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
2224 * Check if user is blocked from editing a particular article
2226 * @param Title $title Title to check
2227 * @param bool $bFromSlave Whether to check the replica DB instead of the master
2230 public function isBlockedFrom( $title, $bFromSlave = false ) {
2231 global $wgBlockAllowsUTEdit;
2233 $blocked = $this->isBlocked( $bFromSlave );
2234 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
2235 // If a user's name is suppressed, they cannot make edits anywhere
2236 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName()
2237 && $title->getNamespace() == NS_USER_TALK
) {
2239 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
2242 Hooks
::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
2248 * If user is blocked, return the name of the user who placed the block
2249 * @return string Name of blocker
2251 public function blockedBy() {
2252 $this->getBlockedStatus();
2253 return $this->mBlockedby
;
2257 * If user is blocked, return the specified reason for the block
2258 * @return string Blocking reason
2260 public function blockedFor() {
2261 $this->getBlockedStatus();
2262 return $this->mBlockreason
;
2266 * If user is blocked, return the ID for the block
2267 * @return int Block ID
2269 public function getBlockId() {
2270 $this->getBlockedStatus();
2271 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2275 * Check if user is blocked on all wikis.
2276 * Do not use for actual edit permission checks!
2277 * This is intended for quick UI checks.
2279 * @param string $ip IP address, uses current client if none given
2280 * @return bool True if blocked, false otherwise
2282 public function isBlockedGlobally( $ip = '' ) {
2283 return $this->getGlobalBlock( $ip ) instanceof Block
;
2287 * Check if user is blocked on all wikis.
2288 * Do not use for actual edit permission checks!
2289 * This is intended for quick UI checks.
2291 * @param string $ip IP address, uses current client if none given
2292 * @return Block|null Block object if blocked, null otherwise
2293 * @throws FatalError
2294 * @throws MWException
2296 public function getGlobalBlock( $ip = '' ) {
2297 if ( $this->mGlobalBlock
!== null ) {
2298 return $this->mGlobalBlock ?
: null;
2300 // User is already an IP?
2301 if ( IP
::isIPAddress( $this->getName() ) ) {
2302 $ip = $this->getName();
2304 $ip = $this->getRequest()->getIP();
2306 // Avoid PHP 7.1 warning of passing $this by reference
2310 Hooks
::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
2312 if ( $blocked && $block === null ) {
2313 // back-compat: UserIsBlockedGlobally didn't have $block param first
2314 $block = new Block( [
2316 'systemBlock' => 'global-block'
2320 $this->mGlobalBlock
= $blocked ?
$block : false;
2321 return $this->mGlobalBlock ?
: null;
2325 * Check if user account is locked
2327 * @return bool True if locked, false otherwise
2329 public function isLocked() {
2330 if ( $this->mLocked
!== null ) {
2331 return $this->mLocked
;
2333 // Avoid PHP 7.1 warning of passing $this by reference
2335 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$user ], null );
2336 $this->mLocked
= $authUser && $authUser->isLocked();
2337 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2338 return $this->mLocked
;
2342 * Check if user account is hidden
2344 * @return bool True if hidden, false otherwise
2346 public function isHidden() {
2347 if ( $this->mHideName
!== null ) {
2348 return $this->mHideName
;
2350 $this->getBlockedStatus();
2351 if ( !$this->mHideName
) {
2352 // Avoid PHP 7.1 warning of passing $this by reference
2354 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$user ], null );
2355 $this->mHideName
= $authUser && $authUser->isHidden();
2356 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2358 return $this->mHideName
;
2362 * Get the user's ID.
2363 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2365 public function getId() {
2366 if ( $this->mId
=== null && $this->mName
!== null && self
::isIP( $this->mName
) ) {
2367 // Special case, we know the user is anonymous
2369 } elseif ( !$this->isItemLoaded( 'id' ) ) {
2370 // Don't load if this was initialized from an ID
2374 return (int)$this->mId
;
2378 * Set the user and reload all fields according to a given ID
2379 * @param int $v User ID to reload
2381 public function setId( $v ) {
2383 $this->clearInstanceCache( 'id' );
2387 * Get the user name, or the IP of an anonymous user
2388 * @return string User's name or IP address
2390 public function getName() {
2391 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2392 // Special case optimisation
2393 return $this->mName
;
2396 if ( $this->mName
=== false ) {
2398 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2400 return $this->mName
;
2405 * Set the user name.
2407 * This does not reload fields from the database according to the given
2408 * name. Rather, it is used to create a temporary "nonexistent user" for
2409 * later addition to the database. It can also be used to set the IP
2410 * address for an anonymous user to something other than the current
2413 * @note User::newFromName() has roughly the same function, when the named user
2415 * @param string $str New user name to set
2417 public function setName( $str ) {
2419 $this->mName
= $str;
2423 * Get the user's actor ID.
2425 * @param IDatabase|null $dbw Assign a new actor ID, using this DB handle, if none exists
2426 * @return int The actor's ID, or 0 if no actor ID exists and $dbw was null
2428 public function getActorId( IDatabase
$dbw = null ) {
2429 global $wgActorTableSchemaMigrationStage;
2431 if ( $wgActorTableSchemaMigrationStage <= MIGRATION_OLD
) {
2435 if ( !$this->isItemLoaded( 'actor' ) ) {
2439 // Currently $this->mActorId might be null if $this was loaded from a
2440 // cache entry that was written when $wgActorTableSchemaMigrationStage
2441 // was MIGRATION_OLD. Once that is no longer a possibility (i.e. when
2442 // User::VERSION is incremented after $wgActorTableSchemaMigrationStage
2443 // has been removed), that condition may be removed.
2444 if ( $this->mActorId
=== null ||
!$this->mActorId
&& $dbw ) {
2446 'actor_user' => $this->getId() ?
: null,
2447 'actor_name' => (string)$this->getName(),
2450 if ( $q['actor_user'] === null && self
::isUsableName( $q['actor_name'] ) ) {
2451 throw new CannotCreateActorException(
2452 'Cannot create an actor for a usable name that is not an existing user'
2455 if ( $q['actor_name'] === '' ) {
2456 throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
2458 $dbw->insert( 'actor', $q, __METHOD__
, [ 'IGNORE' ] );
2459 if ( $dbw->affectedRows() ) {
2460 $this->mActorId
= (int)$dbw->insertId();
2463 list( , $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2464 $this->mActorId
= (int)$dbw->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2465 if ( !$this->mActorId
) {
2466 throw new CannotCreateActorException(
2467 "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
2471 $this->invalidateCache();
2473 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2474 $db = wfGetDB( $index );
2475 $this->mActorId
= (int)$db->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2477 $this->setItemLoaded( 'actor' );
2480 return (int)$this->mActorId
;
2484 * Get the user's name escaped by underscores.
2485 * @return string Username escaped by underscores.
2487 public function getTitleKey() {
2488 return str_replace( ' ', '_', $this->getName() );
2492 * Check if the user has new messages.
2493 * @return bool True if the user has new messages
2495 public function getNewtalk() {
2498 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2499 if ( $this->mNewtalk
=== -1 ) {
2500 $this->mNewtalk
= false; # reset talk page status
2502 // Check memcached separately for anons, who have no
2503 // entire User object stored in there.
2504 if ( !$this->mId
) {
2505 global $wgDisableAnonTalk;
2506 if ( $wgDisableAnonTalk ) {
2507 // Anon newtalk disabled by configuration.
2508 $this->mNewtalk
= false;
2510 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2513 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2517 return (bool)$this->mNewtalk
;
2521 * Return the data needed to construct links for new talk page message
2522 * alerts. If there are new messages, this will return an associative array
2523 * with the following data:
2524 * wiki: The database name of the wiki
2525 * link: Root-relative link to the user's talk page
2526 * rev: The last talk page revision that the user has seen or null. This
2527 * is useful for building diff links.
2528 * If there are no new messages, it returns an empty array.
2529 * @note This function was designed to accomodate multiple talk pages, but
2530 * currently only returns a single link and revision.
2533 public function getNewMessageLinks() {
2534 // Avoid PHP 7.1 warning of passing $this by reference
2537 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
2539 } elseif ( !$this->getNewtalk() ) {
2542 $utp = $this->getTalkPage();
2543 $dbr = wfGetDB( DB_REPLICA
);
2544 // Get the "last viewed rev" timestamp from the oldest message notification
2545 $timestamp = $dbr->selectField( 'user_newtalk',
2546 'MIN(user_last_timestamp)',
2547 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2549 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2550 return [ [ 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ] ];
2554 * Get the revision ID for the last talk page revision viewed by the talk
2556 * @return int|null Revision ID or null
2558 public function getNewMessageRevisionId() {
2559 $newMessageRevisionId = null;
2560 $newMessageLinks = $this->getNewMessageLinks();
2561 if ( $newMessageLinks ) {
2562 // Note: getNewMessageLinks() never returns more than a single link
2563 // and it is always for the same wiki, but we double-check here in
2564 // case that changes some time in the future.
2565 if ( count( $newMessageLinks ) === 1
2566 && $newMessageLinks[0]['wiki'] === wfWikiID()
2567 && $newMessageLinks[0]['rev']
2569 /** @var Revision $newMessageRevision */
2570 $newMessageRevision = $newMessageLinks[0]['rev'];
2571 $newMessageRevisionId = $newMessageRevision->getId();
2574 return $newMessageRevisionId;
2578 * Internal uncached check for new messages
2581 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2582 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2583 * @return bool True if the user has new messages
2585 protected function checkNewtalk( $field, $id ) {
2586 $dbr = wfGetDB( DB_REPLICA
);
2588 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2590 return $ok !== false;
2594 * Add or update the new messages flag
2595 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2596 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2597 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2598 * @return bool True if successful, false otherwise
2600 protected function updateNewtalk( $field, $id, $curRev = null ) {
2601 // Get timestamp of the talk page revision prior to the current one
2602 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2603 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2604 // Mark the user as having new messages since this revision
2605 $dbw = wfGetDB( DB_MASTER
);
2606 $dbw->insert( 'user_newtalk',
2607 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2610 if ( $dbw->affectedRows() ) {
2611 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2614 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2620 * Clear the new messages flag for the given user
2621 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2622 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2623 * @return bool True if successful, false otherwise
2625 protected function deleteNewtalk( $field, $id ) {
2626 $dbw = wfGetDB( DB_MASTER
);
2627 $dbw->delete( 'user_newtalk',
2630 if ( $dbw->affectedRows() ) {
2631 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2634 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2640 * Update the 'You have new messages!' status.
2641 * @param bool $val Whether the user has new messages
2642 * @param Revision $curRev New, as yet unseen revision of the user talk
2643 * page. Ignored if null or !$val.
2645 public function setNewtalk( $val, $curRev = null ) {
2646 if ( wfReadOnly() ) {
2651 $this->mNewtalk
= $val;
2653 if ( $this->isAnon() ) {
2655 $id = $this->getName();
2658 $id = $this->getId();
2662 $changed = $this->updateNewtalk( $field, $id, $curRev );
2664 $changed = $this->deleteNewtalk( $field, $id );
2668 $this->invalidateCache();
2673 * Generate a current or new-future timestamp to be stored in the
2674 * user_touched field when we update things.
2675 * @return string Timestamp in TS_MW format
2677 private function newTouchedTimestamp() {
2678 global $wgClockSkewFudge;
2680 $time = wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2681 if ( $this->mTouched
&& $time <= $this->mTouched
) {
2682 $time = wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2689 * Clear user data from memcached
2691 * Use after applying updates to the database; caller's
2692 * responsibility to update user_touched if appropriate.
2694 * Called implicitly from invalidateCache() and saveSettings().
2696 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2698 public function clearSharedCache( $mode = 'changed' ) {
2699 if ( !$this->getId() ) {
2703 $cache = ObjectCache
::getMainWANInstance();
2704 $key = $this->getCacheKey( $cache );
2705 if ( $mode === 'refresh' ) {
2706 $cache->delete( $key, 1 );
2708 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2709 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2710 $lb->getConnection( DB_MASTER
)->onTransactionPreCommitOrIdle(
2711 function () use ( $cache, $key ) {
2712 $cache->delete( $key );
2717 $cache->delete( $key );
2723 * Immediately touch the user data cache for this account
2725 * Calls touch() and removes account data from memcached
2727 public function invalidateCache() {
2729 $this->clearSharedCache();
2733 * Update the "touched" timestamp for the user
2735 * This is useful on various login/logout events when making sure that
2736 * a browser or proxy that has multiple tenants does not suffer cache
2737 * pollution where the new user sees the old users content. The value
2738 * of getTouched() is checked when determining 304 vs 200 responses.
2739 * Unlike invalidateCache(), this preserves the User object cache and
2740 * avoids database writes.
2744 public function touch() {
2745 $id = $this->getId();
2747 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2748 $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
2749 $cache->touchCheckKey( $key );
2750 $this->mQuickTouched
= null;
2755 * Validate the cache for this account.
2756 * @param string $timestamp A timestamp in TS_MW format
2759 public function validateCache( $timestamp ) {
2760 return ( $timestamp >= $this->getTouched() );
2764 * Get the user touched timestamp
2766 * Use this value only to validate caches via inequalities
2767 * such as in the case of HTTP If-Modified-Since response logic
2769 * @return string TS_MW Timestamp
2771 public function getTouched() {
2775 if ( $this->mQuickTouched
=== null ) {
2776 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2777 $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId
);
2779 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2782 return max( $this->mTouched
, $this->mQuickTouched
);
2785 return $this->mTouched
;
2789 * Get the user_touched timestamp field (time of last DB updates)
2790 * @return string TS_MW Timestamp
2793 public function getDBTouched() {
2796 return $this->mTouched
;
2800 * Set the password and reset the random token.
2801 * Calls through to authentication plugin if necessary;
2802 * will have no effect if the auth plugin refuses to
2803 * pass the change through or if the legal password
2806 * As a special case, setting the password to null
2807 * wipes it, so the account cannot be logged in until
2808 * a new password is set, for instance via e-mail.
2810 * @deprecated since 1.27, use AuthManager instead
2811 * @param string $str New password to set
2812 * @throws PasswordError On failure
2815 public function setPassword( $str ) {
2816 return $this->setPasswordInternal( $str );
2820 * Set the password and reset the random token unconditionally.
2822 * @deprecated since 1.27, use AuthManager instead
2823 * @param string|null $str New password to set or null to set an invalid
2824 * password hash meaning that the user will not be able to log in
2825 * through the web interface.
2827 public function setInternalPassword( $str ) {
2828 $this->setPasswordInternal( $str );
2832 * Actually set the password and such
2833 * @since 1.27 cannot set a password for a user not in the database
2834 * @param string|null $str New password to set or null to set an invalid
2835 * password hash meaning that the user will not be able to log in
2836 * through the web interface.
2837 * @return bool Success
2839 private function setPasswordInternal( $str ) {
2840 $manager = AuthManager
::singleton();
2842 // If the user doesn't exist yet, fail
2843 if ( !$manager->userExists( $this->getName() ) ) {
2844 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2847 $status = $this->changeAuthenticationData( [
2848 'username' => $this->getName(),
2852 if ( !$status->isGood() ) {
2853 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2854 ->info( __METHOD__
. ': Password change rejected: '
2855 . $status->getWikiText( null, null, 'en' ) );
2859 $this->setOption( 'watchlisttoken', false );
2860 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2866 * Changes credentials of the user.
2868 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2869 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2870 * e.g. when no provider handled the change.
2872 * @param array $data A set of authentication data in fieldname => value format. This is the
2873 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2877 public function changeAuthenticationData( array $data ) {
2878 $manager = AuthManager
::singleton();
2879 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2880 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2882 $status = Status
::newGood( 'ignored' );
2883 foreach ( $reqs as $req ) {
2884 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2886 if ( $status->getValue() === 'ignored' ) {
2887 $status->warning( 'authenticationdatachange-ignored' );
2890 if ( $status->isGood() ) {
2891 foreach ( $reqs as $req ) {
2892 $manager->changeAuthenticationData( $req );
2899 * Get the user's current token.
2900 * @param bool $forceCreation Force the generation of a new token if the
2901 * user doesn't have one (default=true for backwards compatibility).
2902 * @return string|null Token
2904 public function getToken( $forceCreation = true ) {
2905 global $wgAuthenticationTokenVersion;
2908 if ( !$this->mToken
&& $forceCreation ) {
2912 if ( !$this->mToken
) {
2913 // The user doesn't have a token, return null to indicate that.
2915 } elseif ( $this->mToken
=== self
::INVALID_TOKEN
) {
2916 // We return a random value here so existing token checks are very
2918 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2919 } elseif ( $wgAuthenticationTokenVersion === null ) {
2920 // $wgAuthenticationTokenVersion not in use, so return the raw secret
2921 return $this->mToken
;
2923 // $wgAuthenticationTokenVersion in use, so hmac it.
2924 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
2926 // The raw hash can be overly long. Shorten it up.
2927 $len = max( 32, self
::TOKEN_LENGTH
);
2928 if ( strlen( $ret ) < $len ) {
2929 // Should never happen, even md5 is 128 bits
2930 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
2932 return substr( $ret, -$len );
2937 * Set the random token (used for persistent authentication)
2938 * Called from loadDefaults() among other places.
2940 * @param string|bool $token If specified, set the token to this value
2942 public function setToken( $token = false ) {
2944 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
2945 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
2946 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
2947 } elseif ( !$token ) {
2948 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2950 $this->mToken
= $token;
2955 * Set the password for a password reminder or new account email
2957 * @deprecated Removed in 1.27. Use PasswordReset instead.
2958 * @param string $str New password to set or null to set an invalid
2959 * password hash meaning that the user will not be able to use it
2960 * @param bool $throttle If true, reset the throttle timestamp to the present
2962 public function setNewpassword( $str, $throttle = true ) {
2963 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2967 * Get the user's e-mail address
2968 * @return string User's email address
2970 public function getEmail() {
2972 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
2973 return $this->mEmail
;
2977 * Get the timestamp of the user's e-mail authentication
2978 * @return string TS_MW timestamp
2980 public function getEmailAuthenticationTimestamp() {
2982 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
2983 return $this->mEmailAuthenticated
;
2987 * Set the user's e-mail address
2988 * @param string $str New e-mail address
2990 public function setEmail( $str ) {
2992 if ( $str == $this->mEmail
) {
2995 $this->invalidateEmail();
2996 $this->mEmail
= $str;
2997 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
3001 * Set the user's e-mail address and a confirmation mail if needed.
3004 * @param string $str New e-mail address
3007 public function setEmailWithConfirmation( $str ) {
3008 global $wgEnableEmail, $wgEmailAuthentication;
3010 if ( !$wgEnableEmail ) {
3011 return Status
::newFatal( 'emaildisabled' );
3014 $oldaddr = $this->getEmail();
3015 if ( $str === $oldaddr ) {
3016 return Status
::newGood( true );
3019 $type = $oldaddr != '' ?
'changed' : 'set';
3020 $notificationResult = null;
3022 if ( $wgEmailAuthentication ) {
3023 // Send the user an email notifying the user of the change in registered
3024 // email address on their previous email address
3025 if ( $type == 'changed' ) {
3026 $change = $str != '' ?
'changed' : 'removed';
3027 $notificationResult = $this->sendMail(
3028 wfMessage( 'notificationemail_subject_' . $change )->text(),
3029 wfMessage( 'notificationemail_body_' . $change,
3030 $this->getRequest()->getIP(),
3037 $this->setEmail( $str );
3039 if ( $str !== '' && $wgEmailAuthentication ) {
3040 // Send a confirmation request to the new address if needed
3041 $result = $this->sendConfirmationMail( $type );
3043 if ( $notificationResult !== null ) {
3044 $result->merge( $notificationResult );
3047 if ( $result->isGood() ) {
3048 // Say to the caller that a confirmation and notification mail has been sent
3049 $result->value
= 'eauth';
3052 $result = Status
::newGood( true );
3059 * Get the user's real name
3060 * @return string User's real name
3062 public function getRealName() {
3063 if ( !$this->isItemLoaded( 'realname' ) ) {
3067 return $this->mRealName
;
3071 * Set the user's real name
3072 * @param string $str New real name
3074 public function setRealName( $str ) {
3076 $this->mRealName
= $str;
3080 * Get the user's current setting for a given option.
3082 * @param string $oname The option to check
3083 * @param string $defaultOverride A default value returned if the option does not exist
3084 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
3085 * @return string|null User's current value for the option
3086 * @see getBoolOption()
3087 * @see getIntOption()
3089 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
3090 global $wgHiddenPrefs;
3091 $this->loadOptions();
3093 # We want 'disabled' preferences to always behave as the default value for
3094 # users, even if they have set the option explicitly in their settings (ie they
3095 # set it, and then it was disabled removing their ability to change it). But
3096 # we don't want to erase the preferences in the database in case the preference
3097 # is re-enabled again. So don't touch $mOptions, just override the returned value
3098 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
3099 return self
::getDefaultOption( $oname );
3102 if ( array_key_exists( $oname, $this->mOptions
) ) {
3103 return $this->mOptions
[$oname];
3105 return $defaultOverride;
3110 * Get all user's options
3112 * @param int $flags Bitwise combination of:
3113 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
3114 * to the default value. (Since 1.25)
3117 public function getOptions( $flags = 0 ) {
3118 global $wgHiddenPrefs;
3119 $this->loadOptions();
3120 $options = $this->mOptions
;
3122 # We want 'disabled' preferences to always behave as the default value for
3123 # users, even if they have set the option explicitly in their settings (ie they
3124 # set it, and then it was disabled removing their ability to change it). But
3125 # we don't want to erase the preferences in the database in case the preference
3126 # is re-enabled again. So don't touch $mOptions, just override the returned value
3127 foreach ( $wgHiddenPrefs as $pref ) {
3128 $default = self
::getDefaultOption( $pref );
3129 if ( $default !== null ) {
3130 $options[$pref] = $default;
3134 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
3135 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
3142 * Get the user's current setting for a given option, as a boolean value.
3144 * @param string $oname The option to check
3145 * @return bool User's current value for the option
3148 public function getBoolOption( $oname ) {
3149 return (bool)$this->getOption( $oname );
3153 * Get the user's current setting for a given option, as an integer value.
3155 * @param string $oname The option to check
3156 * @param int $defaultOverride A default value returned if the option does not exist
3157 * @return int User's current value for the option
3160 public function getIntOption( $oname, $defaultOverride = 0 ) {
3161 $val = $this->getOption( $oname );
3163 $val = $defaultOverride;
3165 return intval( $val );
3169 * Set the given option for a user.
3171 * You need to call saveSettings() to actually write to the database.
3173 * @param string $oname The option to set
3174 * @param mixed $val New value to set
3176 public function setOption( $oname, $val ) {
3177 $this->loadOptions();
3179 // Explicitly NULL values should refer to defaults
3180 if ( is_null( $val ) ) {
3181 $val = self
::getDefaultOption( $oname );
3184 $this->mOptions
[$oname] = $val;
3188 * Get a token stored in the preferences (like the watchlist one),
3189 * resetting it if it's empty (and saving changes).
3191 * @param string $oname The option name to retrieve the token from
3192 * @return string|bool User's current value for the option, or false if this option is disabled.
3193 * @see resetTokenFromOption()
3195 * @deprecated since 1.26 Applications should use the OAuth extension
3197 public function getTokenFromOption( $oname ) {
3198 global $wgHiddenPrefs;
3200 $id = $this->getId();
3201 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
3205 $token = $this->getOption( $oname );
3207 // Default to a value based on the user token to avoid space
3208 // wasted on storing tokens for all users. When this option
3209 // is set manually by the user, only then is it stored.
3210 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
3217 * Reset a token stored in the preferences (like the watchlist one).
3218 * *Does not* save user's preferences (similarly to setOption()).
3220 * @param string $oname The option name to reset the token in
3221 * @return string|bool New token value, or false if this option is disabled.
3222 * @see getTokenFromOption()
3225 public function resetTokenFromOption( $oname ) {
3226 global $wgHiddenPrefs;
3227 if ( in_array( $oname, $wgHiddenPrefs ) ) {
3231 $token = MWCryptRand
::generateHex( 40 );
3232 $this->setOption( $oname, $token );
3237 * Return a list of the types of user options currently returned by
3238 * User::getOptionKinds().
3240 * Currently, the option kinds are:
3241 * - 'registered' - preferences which are registered in core MediaWiki or
3242 * by extensions using the UserGetDefaultOptions hook.
3243 * - 'registered-multiselect' - as above, using the 'multiselect' type.
3244 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
3245 * - 'userjs' - preferences with names starting with 'userjs-', intended to
3246 * be used by user scripts.
3247 * - 'special' - "preferences" that are not accessible via User::getOptions
3248 * or User::setOptions.
3249 * - 'unused' - preferences about which MediaWiki doesn't know anything.
3250 * These are usually legacy options, removed in newer versions.
3252 * The API (and possibly others) use this function to determine the possible
3253 * option types for validation purposes, so make sure to update this when a
3254 * new option kind is added.
3256 * @see User::getOptionKinds
3257 * @return array Option kinds
3259 public static function listOptionKinds() {
3262 'registered-multiselect',
3263 'registered-checkmatrix',
3271 * Return an associative array mapping preferences keys to the kind of a preference they're
3272 * used for. Different kinds are handled differently when setting or reading preferences.
3274 * See User::listOptionKinds for the list of valid option types that can be provided.
3276 * @see User::listOptionKinds
3277 * @param IContextSource $context
3278 * @param array $options Assoc. array with options keys to check as keys.
3279 * Defaults to $this->mOptions.
3280 * @return array The key => kind mapping data
3282 public function getOptionKinds( IContextSource
$context, $options = null ) {
3283 $this->loadOptions();
3284 if ( $options === null ) {
3285 $options = $this->mOptions
;
3288 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
3289 $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
3292 // Pull out the "special" options, so they don't get converted as
3293 // multiselect or checkmatrix.
3294 $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
3295 foreach ( $specialOptions as $name => $value ) {
3296 unset( $prefs[$name] );
3299 // Multiselect and checkmatrix options are stored in the database with
3300 // one key per option, each having a boolean value. Extract those keys.
3301 $multiselectOptions = [];
3302 foreach ( $prefs as $name => $info ) {
3303 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3304 ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField
::class ) ) {
3305 $opts = HTMLFormField
::flattenOptions( $info['options'] );
3306 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
3308 foreach ( $opts as $value ) {
3309 $multiselectOptions["$prefix$value"] = true;
3312 unset( $prefs[$name] );
3315 $checkmatrixOptions = [];
3316 foreach ( $prefs as $name => $info ) {
3317 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3318 ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix
::class ) ) {
3319 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3320 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3321 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
3323 foreach ( $columns as $column ) {
3324 foreach ( $rows as $row ) {
3325 $checkmatrixOptions["$prefix$column-$row"] = true;
3329 unset( $prefs[$name] );
3333 // $value is ignored
3334 foreach ( $options as $key => $value ) {
3335 if ( isset( $prefs[$key] ) ) {
3336 $mapping[$key] = 'registered';
3337 } elseif ( isset( $multiselectOptions[$key] ) ) {
3338 $mapping[$key] = 'registered-multiselect';
3339 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3340 $mapping[$key] = 'registered-checkmatrix';
3341 } elseif ( isset( $specialOptions[$key] ) ) {
3342 $mapping[$key] = 'special';
3343 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3344 $mapping[$key] = 'userjs';
3346 $mapping[$key] = 'unused';
3354 * Reset certain (or all) options to the site defaults
3356 * The optional parameter determines which kinds of preferences will be reset.
3357 * Supported values are everything that can be reported by getOptionKinds()
3358 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3360 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3361 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3362 * for backwards-compatibility.
3363 * @param IContextSource|null $context Context source used when $resetKinds
3364 * does not contain 'all', passed to getOptionKinds().
3365 * Defaults to RequestContext::getMain() when null.
3367 public function resetOptions(
3368 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3369 IContextSource
$context = null
3372 $defaultOptions = self
::getDefaultOptions();
3374 if ( !is_array( $resetKinds ) ) {
3375 $resetKinds = [ $resetKinds ];
3378 if ( in_array( 'all', $resetKinds ) ) {
3379 $newOptions = $defaultOptions;
3381 if ( $context === null ) {
3382 $context = RequestContext
::getMain();
3385 $optionKinds = $this->getOptionKinds( $context );
3386 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3389 // Use default values for the options that should be deleted, and
3390 // copy old values for the ones that shouldn't.
3391 foreach ( $this->mOptions
as $key => $value ) {
3392 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3393 if ( array_key_exists( $key, $defaultOptions ) ) {
3394 $newOptions[$key] = $defaultOptions[$key];
3397 $newOptions[$key] = $value;
3402 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3404 $this->mOptions
= $newOptions;
3405 $this->mOptionsLoaded
= true;
3409 * Get the user's preferred date format.
3410 * @return string User's preferred date format
3412 public function getDatePreference() {
3413 // Important migration for old data rows
3414 if ( is_null( $this->mDatePreference
) ) {
3416 $value = $this->getOption( 'date' );
3417 $map = $wgLang->getDatePreferenceMigrationMap();
3418 if ( isset( $map[$value] ) ) {
3419 $value = $map[$value];
3421 $this->mDatePreference
= $value;
3423 return $this->mDatePreference
;
3427 * Determine based on the wiki configuration and the user's options,
3428 * whether this user must be over HTTPS no matter what.
3432 public function requiresHTTPS() {
3433 global $wgSecureLogin;
3434 if ( !$wgSecureLogin ) {
3437 $https = $this->getBoolOption( 'prefershttps' );
3438 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3440 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3447 * Get the user preferred stub threshold
3451 public function getStubThreshold() {
3452 global $wgMaxArticleSize; # Maximum article size, in Kb
3453 $threshold = $this->getIntOption( 'stubthreshold' );
3454 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3455 // If they have set an impossible value, disable the preference
3456 // so we can use the parser cache again.
3463 * Get the permissions this user has.
3464 * @return string[] permission names
3466 public function getRights() {
3467 if ( is_null( $this->mRights
) ) {
3468 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3469 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3471 // Deny any rights denied by the user's session, unless this
3472 // endpoint has no sessions.
3473 if ( !defined( 'MW_NO_SESSION' ) ) {
3474 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3475 if ( $allowedRights !== null ) {
3476 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3480 // Force reindexation of rights when a hook has unset one of them
3481 $this->mRights
= array_values( array_unique( $this->mRights
) );
3483 // If block disables login, we should also remove any
3484 // extra rights blocked users might have, in case the
3485 // blocked user has a pre-existing session (T129738).
3486 // This is checked here for cases where people only call
3487 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3488 // to give a better error message in the common case.
3489 $config = RequestContext
::getMain()->getConfig();
3491 $this->isLoggedIn() &&
3492 $config->get( 'BlockDisablesLogin' ) &&
3496 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3499 return $this->mRights
;
3503 * Get the list of explicit group memberships this user has.
3504 * The implicit * and user groups are not included.
3505 * @return array Array of String internal group names
3507 public function getGroups() {
3509 $this->loadGroups();
3510 return array_keys( $this->mGroupMemberships
);
3514 * Get the list of explicit group memberships this user has, stored as
3515 * UserGroupMembership objects. Implicit groups are not included.
3517 * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
3520 public function getGroupMemberships() {
3522 $this->loadGroups();
3523 return $this->mGroupMemberships
;
3527 * Get the list of implicit group memberships this user has.
3528 * This includes all explicit groups, plus 'user' if logged in,
3529 * '*' for all accounts, and autopromoted groups
3530 * @param bool $recache Whether to avoid the cache
3531 * @return array Array of String internal group names
3533 public function getEffectiveGroups( $recache = false ) {
3534 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3535 $this->mEffectiveGroups
= array_unique( array_merge(
3536 $this->getGroups(), // explicit groups
3537 $this->getAutomaticGroups( $recache ) // implicit groups
3539 // Avoid PHP 7.1 warning of passing $this by reference
3541 // Hook for additional groups
3542 Hooks
::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups
] );
3543 // Force reindexation of groups when a hook has unset one of them
3544 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3546 return $this->mEffectiveGroups
;
3550 * Get the list of implicit group memberships this user has.
3551 * This includes 'user' if logged in, '*' for all accounts,
3552 * and autopromoted groups
3553 * @param bool $recache Whether to avoid the cache
3554 * @return array Array of String internal group names
3556 public function getAutomaticGroups( $recache = false ) {
3557 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3558 $this->mImplicitGroups
= [ '*' ];
3559 if ( $this->getId() ) {
3560 $this->mImplicitGroups
[] = 'user';
3562 $this->mImplicitGroups
= array_unique( array_merge(
3563 $this->mImplicitGroups
,
3564 Autopromote
::getAutopromoteGroups( $this )
3568 // Assure data consistency with rights/groups,
3569 // as getEffectiveGroups() depends on this function
3570 $this->mEffectiveGroups
= null;
3573 return $this->mImplicitGroups
;
3577 * Returns the groups the user has belonged to.
3579 * The user may still belong to the returned groups. Compare with getGroups().
3581 * The function will not return groups the user had belonged to before MW 1.17
3583 * @return array Names of the groups the user has belonged to.
3585 public function getFormerGroups() {
3588 if ( is_null( $this->mFormerGroups
) ) {
3589 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3590 ?
wfGetDB( DB_MASTER
)
3591 : wfGetDB( DB_REPLICA
);
3592 $res = $db->select( 'user_former_groups',
3594 [ 'ufg_user' => $this->mId
],
3596 $this->mFormerGroups
= [];
3597 foreach ( $res as $row ) {
3598 $this->mFormerGroups
[] = $row->ufg_group
;
3602 return $this->mFormerGroups
;
3606 * Get the user's edit count.
3607 * @return int|null Null for anonymous users
3609 public function getEditCount() {
3610 if ( !$this->getId() ) {
3614 if ( $this->mEditCount
=== null ) {
3615 /* Populate the count, if it has not been populated yet */
3616 $dbr = wfGetDB( DB_REPLICA
);
3617 // check if the user_editcount field has been initialized
3618 $count = $dbr->selectField(
3619 'user', 'user_editcount',
3620 [ 'user_id' => $this->mId
],
3624 if ( $count === null ) {
3625 // it has not been initialized. do so.
3626 $count = $this->initEditCount();
3628 $this->mEditCount
= $count;
3630 return (int)$this->mEditCount
;
3634 * Add the user to the given group. This takes immediate effect.
3635 * If the user is already in the group, the expiry time will be updated to the new
3636 * expiry time. (If $expiry is omitted or null, the membership will be altered to
3639 * @param string $group Name of the group to add
3640 * @param string $expiry Optional expiry timestamp in any format acceptable to
3641 * wfTimestamp(), or null if the group assignment should not expire
3644 public function addGroup( $group, $expiry = null ) {
3646 $this->loadGroups();
3649 $expiry = wfTimestamp( TS_MW
, $expiry );
3652 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
3656 // create the new UserGroupMembership and put it in the DB
3657 $ugm = new UserGroupMembership( $this->mId
, $group, $expiry );
3658 if ( !$ugm->insert( true ) ) {
3662 $this->mGroupMemberships
[$group] = $ugm;
3664 // Refresh the groups caches, and clear the rights cache so it will be
3665 // refreshed on the next call to $this->getRights().
3666 $this->getEffectiveGroups( true );
3667 $this->mRights
= null;
3669 $this->invalidateCache();
3675 * Remove the user from the given group.
3676 * This takes immediate effect.
3677 * @param string $group Name of the group to remove
3680 public function removeGroup( $group ) {
3683 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3687 $ugm = UserGroupMembership
::getMembership( $this->mId
, $group );
3688 // delete the membership entry
3689 if ( !$ugm ||
!$ugm->delete() ) {
3693 $this->loadGroups();
3694 unset( $this->mGroupMemberships
[$group] );
3696 // Refresh the groups caches, and clear the rights cache so it will be
3697 // refreshed on the next call to $this->getRights().
3698 $this->getEffectiveGroups( true );
3699 $this->mRights
= null;
3701 $this->invalidateCache();
3707 * Get whether the user is logged in
3710 public function isLoggedIn() {
3711 return $this->getId() != 0;
3715 * Get whether the user is anonymous
3718 public function isAnon() {
3719 return !$this->isLoggedIn();
3723 * @return bool Whether this user is flagged as being a bot role account
3726 public function isBot() {
3727 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3732 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3738 * Check if user is allowed to access a feature / make an action
3740 * @param string $permissions,... Permissions to test
3741 * @return bool True if user is allowed to perform *any* of the given actions
3743 public function isAllowedAny() {
3744 $permissions = func_get_args();
3745 foreach ( $permissions as $permission ) {
3746 if ( $this->isAllowed( $permission ) ) {
3755 * @param string $permissions,... Permissions to test
3756 * @return bool True if the user is allowed to perform *all* of the given actions
3758 public function isAllowedAll() {
3759 $permissions = func_get_args();
3760 foreach ( $permissions as $permission ) {
3761 if ( !$this->isAllowed( $permission ) ) {
3769 * Internal mechanics of testing a permission
3770 * @param string $action
3773 public function isAllowed( $action = '' ) {
3774 if ( $action === '' ) {
3775 return true; // In the spirit of DWIM
3777 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3778 // by misconfiguration: 0 == 'foo'
3779 return in_array( $action, $this->getRights(), true );
3783 * Check whether to enable recent changes patrol features for this user
3784 * @return bool True or false
3786 public function useRCPatrol() {
3787 global $wgUseRCPatrol;
3788 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3792 * Check whether to enable new pages patrol features for this user
3793 * @return bool True or false
3795 public function useNPPatrol() {
3796 global $wgUseRCPatrol, $wgUseNPPatrol;
3798 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3799 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3804 * Check whether to enable new files patrol features for this user
3805 * @return bool True or false
3807 public function useFilePatrol() {
3808 global $wgUseRCPatrol, $wgUseFilePatrol;
3810 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3811 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3816 * Get the WebRequest object to use with this object
3818 * @return WebRequest
3820 public function getRequest() {
3821 if ( $this->mRequest
) {
3822 return $this->mRequest
;
3830 * Check the watched status of an article.
3831 * @since 1.22 $checkRights parameter added
3832 * @param Title $title Title of the article to look at
3833 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3834 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3837 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3838 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3839 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3846 * @since 1.22 $checkRights parameter added
3847 * @param Title $title Title of the article to look at
3848 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3849 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3851 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3852 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3853 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3855 [ $title->getSubjectPage(), $title->getTalkPage() ]
3858 $this->invalidateCache();
3862 * Stop watching an article.
3863 * @since 1.22 $checkRights parameter added
3864 * @param Title $title Title of the article to look at
3865 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3866 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3868 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3869 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3870 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3871 $store->removeWatch( $this, $title->getSubjectPage() );
3872 $store->removeWatch( $this, $title->getTalkPage() );
3874 $this->invalidateCache();
3878 * Clear the user's notification timestamp for the given title.
3879 * If e-notif e-mails are on, they will receive notification mails on
3880 * the next change of the page if it's watched etc.
3881 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3882 * @param Title &$title Title of the article to look at
3883 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3885 public function clearNotification( &$title, $oldid = 0 ) {
3886 global $wgUseEnotif, $wgShowUpdatedMarker;
3888 // Do nothing if the database is locked to writes
3889 if ( wfReadOnly() ) {
3893 // Do nothing if not allowed to edit the watchlist
3894 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3898 // If we're working on user's talk page, we should update the talk page message indicator
3899 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3900 // Avoid PHP 7.1 warning of passing $this by reference
3902 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
3906 // Try to update the DB post-send and only if needed...
3907 DeferredUpdates
::addCallableUpdate( function () use ( $title, $oldid ) {
3908 if ( !$this->getNewtalk() ) {
3909 return; // no notifications to clear
3912 // Delete the last notifications (they stack up)
3913 $this->setNewtalk( false );
3915 // If there is a new, unseen, revision, use its timestamp
3917 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
3920 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
3925 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3929 if ( $this->isAnon() ) {
3930 // Nothing else to do...
3934 // Only update the timestamp if the page is being watched.
3935 // The query to find out if it is watched is cached both in memcached and per-invocation,
3936 // and when it does have to be executed, it can be on a replica DB
3937 // If this is the user's newtalk page, we always update the timestamp
3939 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3943 MediaWikiServices
::getInstance()->getWatchedItemStore()
3944 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
3948 * Resets all of the given user's page-change notification timestamps.
3949 * If e-notif e-mails are on, they will receive notification mails on
3950 * the next change of any watched page.
3951 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3953 public function clearAllNotifications() {
3954 global $wgUseEnotif, $wgShowUpdatedMarker;
3955 // Do nothing if not allowed to edit the watchlist
3956 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
3960 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3961 $this->setNewtalk( false );
3965 $id = $this->getId();
3970 $dbw = wfGetDB( DB_MASTER
);
3971 $asOfTimes = array_unique( $dbw->selectFieldValues(
3973 'wl_notificationtimestamp',
3974 [ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ],
3976 [ 'ORDER BY' => 'wl_notificationtimestamp DESC', 'LIMIT' => 500 ]
3978 if ( !$asOfTimes ) {
3981 // Immediately update the most recent touched rows, which hopefully covers what
3982 // the user sees on the watchlist page before pressing "mark all pages visited"....
3985 [ 'wl_notificationtimestamp' => null ],
3986 [ 'wl_user' => $id, 'wl_notificationtimestamp' => $asOfTimes ],
3989 // ...and finish the older ones in a post-send update with lag checks...
3990 DeferredUpdates
::addUpdate( new AutoCommitUpdate(
3993 function () use ( $dbw, $id ) {
3994 global $wgUpdateRowsPerQuery;
3996 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
3997 $ticket = $lbFactory->getEmptyTransactionTicket( __METHOD__
);
3998 $asOfTimes = array_unique( $dbw->selectFieldValues(
4000 'wl_notificationtimestamp',
4001 [ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ],
4004 foreach ( array_chunk( $asOfTimes, $wgUpdateRowsPerQuery ) as $asOfTimeBatch ) {
4007 [ 'wl_notificationtimestamp' => null ],
4008 [ 'wl_user' => $id, 'wl_notificationtimestamp' => $asOfTimeBatch ],
4011 $lbFactory->commitAndWaitForReplication( __METHOD__
, $ticket );
4015 // We also need to clear here the "you have new message" notification for the own
4016 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
4020 * Compute experienced level based on edit count and registration date.
4022 * @return string 'newcomer', 'learner', or 'experienced'
4024 public function getExperienceLevel() {
4025 global $wgLearnerEdits,
4026 $wgExperiencedUserEdits,
4027 $wgLearnerMemberSince,
4028 $wgExperiencedUserMemberSince;
4030 if ( $this->isAnon() ) {
4034 $editCount = $this->getEditCount();
4035 $registration = $this->getRegistration();
4037 $learnerRegistration = wfTimestamp( TS_MW
, $now - $wgLearnerMemberSince * 86400 );
4038 $experiencedRegistration = wfTimestamp( TS_MW
, $now - $wgExperiencedUserMemberSince * 86400 );
4041 $editCount < $wgLearnerEdits ||
4042 $registration > $learnerRegistration
4046 $editCount > $wgExperiencedUserEdits &&
4047 $registration <= $experiencedRegistration
4049 return 'experienced';
4056 * Set a cookie on the user's client. Wrapper for
4057 * WebResponse::setCookie
4058 * @deprecated since 1.27
4059 * @param string $name Name of the cookie to set
4060 * @param string $value Value to set
4061 * @param int $exp Expiration time, as a UNIX time value;
4062 * if 0 or not specified, use the default $wgCookieExpiration
4063 * @param bool $secure
4064 * true: Force setting the secure attribute when setting the cookie
4065 * false: Force NOT setting the secure attribute when setting the cookie
4066 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
4067 * @param array $params Array of options sent passed to WebResponse::setcookie()
4068 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
4071 protected function setCookie(
4072 $name, $value, $exp = 0, $secure = null, $params = [], $request = null
4074 wfDeprecated( __METHOD__
, '1.27' );
4075 if ( $request === null ) {
4076 $request = $this->getRequest();
4078 $params['secure'] = $secure;
4079 $request->response()->setCookie( $name, $value, $exp, $params );
4083 * Clear a cookie on the user's client
4084 * @deprecated since 1.27
4085 * @param string $name Name of the cookie to clear
4086 * @param bool $secure
4087 * true: Force setting the secure attribute when setting the cookie
4088 * false: Force NOT setting the secure attribute when setting the cookie
4089 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
4090 * @param array $params Array of options sent passed to WebResponse::setcookie()
4092 protected function clearCookie( $name, $secure = null, $params = [] ) {
4093 wfDeprecated( __METHOD__
, '1.27' );
4094 $this->setCookie( $name, '', time() - 86400, $secure, $params );
4098 * Set an extended login cookie on the user's client. The expiry of the cookie
4099 * is controlled by the $wgExtendedLoginCookieExpiration configuration
4102 * @see User::setCookie
4104 * @deprecated since 1.27
4105 * @param string $name Name of the cookie to set
4106 * @param string $value Value to set
4107 * @param bool $secure
4108 * true: Force setting the secure attribute when setting the cookie
4109 * false: Force NOT setting the secure attribute when setting the cookie
4110 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
4112 protected function setExtendedLoginCookie( $name, $value, $secure ) {
4113 global $wgExtendedLoginCookieExpiration, $wgCookieExpiration;
4115 wfDeprecated( __METHOD__
, '1.27' );
4118 $exp +
= $wgExtendedLoginCookieExpiration !== null
4119 ?
$wgExtendedLoginCookieExpiration
4120 : $wgCookieExpiration;
4122 $this->setCookie( $name, $value, $exp, $secure );
4126 * Persist this user's session (e.g. set cookies)
4128 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
4130 * @param bool $secure Whether to force secure/insecure cookies or use default
4131 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
4133 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
4135 if ( 0 == $this->mId
) {
4139 $session = $this->getRequest()->getSession();
4140 if ( $request && $session->getRequest() !== $request ) {
4141 $session = $session->sessionWithRequest( $request );
4143 $delay = $session->delaySave();
4145 if ( !$session->getUser()->equals( $this ) ) {
4146 if ( !$session->canSetUser() ) {
4147 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4148 ->warning( __METHOD__
.
4149 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
4153 $session->setUser( $this );
4156 $session->setRememberUser( $rememberMe );
4157 if ( $secure !== null ) {
4158 $session->setForceHTTPS( $secure );
4161 $session->persist();
4163 ScopedCallback
::consume( $delay );
4167 * Log this user out.
4169 public function logout() {
4170 // Avoid PHP 7.1 warning of passing $this by reference
4172 if ( Hooks
::run( 'UserLogout', [ &$user ] ) ) {
4178 * Clear the user's session, and reset the instance cache.
4181 public function doLogout() {
4182 $session = $this->getRequest()->getSession();
4183 if ( !$session->canSetUser() ) {
4184 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4185 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
4186 $error = 'immutable';
4187 } elseif ( !$session->getUser()->equals( $this ) ) {
4188 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4189 ->warning( __METHOD__
.
4190 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
4192 // But we still may as well make this user object anon
4193 $this->clearInstanceCache( 'defaults' );
4194 $error = 'wronguser';
4196 $this->clearInstanceCache( 'defaults' );
4197 $delay = $session->delaySave();
4198 $session->unpersist(); // Clear cookies (T127436)
4199 $session->setLoggedOutTimestamp( time() );
4200 $session->setUser( new User
);
4201 $session->set( 'wsUserID', 0 ); // Other code expects this
4202 $session->resetAllTokens();
4203 ScopedCallback
::consume( $delay );
4206 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
4207 'event' => 'logout',
4208 'successful' => $error === false,
4209 'status' => $error ?
: 'success',
4214 * Save this user's settings into the database.
4215 * @todo Only rarely do all these fields need to be set!
4217 public function saveSettings() {
4218 if ( wfReadOnly() ) {
4219 // @TODO: caller should deal with this instead!
4220 // This should really just be an exception.
4221 MWExceptionHandler
::logException( new DBExpectedError(
4223 "Could not update user with ID '{$this->mId}'; DB is read-only."
4229 if ( 0 == $this->mId
) {
4233 // Get a new user_touched that is higher than the old one.
4234 // This will be used for a CAS check as a last-resort safety
4235 // check against race conditions and replica DB lag.
4236 $newTouched = $this->newTouchedTimestamp();
4238 $dbw = wfGetDB( DB_MASTER
);
4239 $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $newTouched ) {
4240 global $wgActorTableSchemaMigrationStage;
4242 $dbw->update( 'user',
4244 'user_name' => $this->mName
,
4245 'user_real_name' => $this->mRealName
,
4246 'user_email' => $this->mEmail
,
4247 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4248 'user_touched' => $dbw->timestamp( $newTouched ),
4249 'user_token' => strval( $this->mToken
),
4250 'user_email_token' => $this->mEmailToken
,
4251 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
4252 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
4253 'user_id' => $this->mId
,
4257 if ( !$dbw->affectedRows() ) {
4258 // Maybe the problem was a missed cache update; clear it to be safe
4259 $this->clearSharedCache( 'refresh' );
4260 // User was changed in the meantime or loaded with stale data
4261 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
4262 throw new MWException(
4263 "CAS update failed on user_touched for user ID '{$this->mId}' (read from $from);" .
4264 " the version of the user to be saved is older than the current version."
4268 if ( $wgActorTableSchemaMigrationStage > MIGRATION_OLD
) {
4271 [ 'actor_name' => $this->mName
],
4272 [ 'actor_user' => $this->mId
],
4278 $this->mTouched
= $newTouched;
4279 $this->saveOptions();
4281 Hooks
::run( 'UserSaveSettings', [ $this ] );
4282 $this->clearSharedCache();
4283 $this->getUserPage()->invalidateCache();
4287 * If only this user's username is known, and it exists, return the user ID.
4289 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
4292 public function idForName( $flags = 0 ) {
4293 $s = trim( $this->getName() );
4298 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
4299 ?
wfGetDB( DB_MASTER
)
4300 : wfGetDB( DB_REPLICA
);
4302 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
4303 ?
[ 'LOCK IN SHARE MODE' ]
4306 $id = $db->selectField( 'user',
4307 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
4313 * Add a user to the database, return the user object
4315 * @param string $name Username to add
4316 * @param array $params Array of Strings Non-default parameters to save to
4317 * the database as user_* fields:
4318 * - email: The user's email address.
4319 * - email_authenticated: The email authentication timestamp.
4320 * - real_name: The user's real name.
4321 * - options: An associative array of non-default options.
4322 * - token: Random authentication token. Do not set.
4323 * - registration: Registration timestamp. Do not set.
4325 * @return User|null User object, or null if the username already exists.
4327 public static function createNew( $name, $params = [] ) {
4328 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
4329 if ( isset( $params[$field] ) ) {
4330 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
4331 unset( $params[$field] );
4337 $user->setToken(); // init token
4338 if ( isset( $params['options'] ) ) {
4339 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
4340 unset( $params['options'] );
4342 $dbw = wfGetDB( DB_MASTER
);
4344 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4347 'user_name' => $name,
4348 'user_password' => $noPass,
4349 'user_newpassword' => $noPass,
4350 'user_email' => $user->mEmail
,
4351 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
4352 'user_real_name' => $user->mRealName
,
4353 'user_token' => strval( $user->mToken
),
4354 'user_registration' => $dbw->timestamp( $user->mRegistration
),
4355 'user_editcount' => 0,
4356 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4358 foreach ( $params as $name => $value ) {
4359 $fields["user_$name"] = $value;
4362 return $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $fields ) {
4363 $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
4364 if ( $dbw->affectedRows() ) {
4365 $newUser = self
::newFromId( $dbw->insertId() );
4366 // Load the user from master to avoid replica lag
4367 $newUser->load( self
::READ_LATEST
);
4368 $newUser->updateActorId( $dbw );
4377 * Add this existing user object to the database. If the user already
4378 * exists, a fatal status object is returned, and the user object is
4379 * initialised with the data from the database.
4381 * Previously, this function generated a DB error due to a key conflict
4382 * if the user already existed. Many extension callers use this function
4383 * in code along the lines of:
4385 * $user = User::newFromName( $name );
4386 * if ( !$user->isLoggedIn() ) {
4387 * $user->addToDatabase();
4389 * // do something with $user...
4391 * However, this was vulnerable to a race condition (T18020). By
4392 * initialising the user object if the user exists, we aim to support this
4393 * calling sequence as far as possible.
4395 * Note that if the user exists, this function will acquire a write lock,
4396 * so it is still advisable to make the call conditional on isLoggedIn(),
4397 * and to commit the transaction after calling.
4399 * @throws MWException
4402 public function addToDatabase() {
4404 if ( !$this->mToken
) {
4405 $this->setToken(); // init token
4408 if ( !is_string( $this->mName
) ) {
4409 throw new RuntimeException( "User name field is not set." );
4412 $this->mTouched
= $this->newTouchedTimestamp();
4414 $dbw = wfGetDB( DB_MASTER
);
4415 $status = $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) {
4416 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4417 $dbw->insert( 'user',
4419 'user_name' => $this->mName
,
4420 'user_password' => $noPass,
4421 'user_newpassword' => $noPass,
4422 'user_email' => $this->mEmail
,
4423 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4424 'user_real_name' => $this->mRealName
,
4425 'user_token' => strval( $this->mToken
),
4426 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4427 'user_editcount' => 0,
4428 'user_touched' => $dbw->timestamp( $this->mTouched
),
4432 if ( !$dbw->affectedRows() ) {
4433 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4434 $this->mId
= $dbw->selectField(
4437 [ 'user_name' => $this->mName
],
4439 [ 'LOCK IN SHARE MODE' ]
4443 if ( $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4448 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
4449 "to insert user '{$this->mName}' row, but it was not present in select!" );
4451 return Status
::newFatal( 'userexists' );
4453 $this->mId
= $dbw->insertId();
4454 self
::$idCacheByName[$this->mName
] = $this->mId
;
4455 $this->updateActorId( $dbw );
4457 return Status
::newGood();
4459 if ( !$status->isGood() ) {
4463 // Clear instance cache other than user table data and actor, which is already accurate
4464 $this->clearInstanceCache();
4466 $this->saveOptions();
4467 return Status
::newGood();
4471 * Update the actor ID after an insert
4472 * @param IDatabase $dbw Writable database handle
4474 private function updateActorId( IDatabase
$dbw ) {
4475 global $wgActorTableSchemaMigrationStage;
4477 if ( $wgActorTableSchemaMigrationStage > MIGRATION_OLD
) {
4480 [ 'actor_user' => $this->mId
, 'actor_name' => $this->mName
],
4483 $this->mActorId
= (int)$dbw->insertId();
4488 * If this user is logged-in and blocked,
4489 * block any IP address they've successfully logged in from.
4490 * @return bool A block was spread
4492 public function spreadAnyEditBlock() {
4493 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4494 return $this->spreadBlock();
4501 * If this (non-anonymous) user is blocked,
4502 * block the IP address they've successfully logged in from.
4503 * @return bool A block was spread
4505 protected function spreadBlock() {
4506 wfDebug( __METHOD__
. "()\n" );
4508 if ( $this->mId
== 0 ) {
4512 $userblock = Block
::newFromTarget( $this->getName() );
4513 if ( !$userblock ) {
4517 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4521 * Get whether the user is explicitly blocked from account creation.
4522 * @return bool|Block
4524 public function isBlockedFromCreateAccount() {
4525 $this->getBlockedStatus();
4526 if ( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
4527 return $this->mBlock
;
4530 # T15611: if the IP address the user is trying to create an account from is
4531 # blocked with createaccount disabled, prevent new account creation there even
4532 # when the user is logged in
4533 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4534 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4536 return $this->mBlockedFromCreateAccount
instanceof Block
4537 && $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
4538 ?
$this->mBlockedFromCreateAccount
4543 * Get whether the user is blocked from using Special:Emailuser.
4546 public function isBlockedFromEmailuser() {
4547 $this->getBlockedStatus();
4548 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
4552 * Get whether the user is allowed to create an account.
4555 public function isAllowedToCreateAccount() {
4556 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4560 * Get this user's personal page title.
4562 * @return Title User's personal page title
4564 public function getUserPage() {
4565 return Title
::makeTitle( NS_USER
, $this->getName() );
4569 * Get this user's talk page title.
4571 * @return Title User's talk page title
4573 public function getTalkPage() {
4574 $title = $this->getUserPage();
4575 return $title->getTalkPage();
4579 * Determine whether the user is a newbie. Newbies are either
4580 * anonymous IPs, or the most recently created accounts.
4583 public function isNewbie() {
4584 return !$this->isAllowed( 'autoconfirmed' );
4588 * Check to see if the given clear-text password is one of the accepted passwords
4589 * @deprecated since 1.27, use AuthManager instead
4590 * @param string $password User password
4591 * @return bool True if the given password is correct, otherwise False
4593 public function checkPassword( $password ) {
4594 $manager = AuthManager
::singleton();
4595 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4596 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4598 'username' => $this->getName(),
4599 'password' => $password,
4602 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4603 switch ( $res->status
) {
4604 case AuthenticationResponse
::PASS
:
4606 case AuthenticationResponse
::FAIL
:
4607 // Hope it's not a PreAuthenticationProvider that failed...
4608 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4609 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4612 throw new BadMethodCallException(
4613 'AuthManager returned a response unsupported by ' . __METHOD__
4619 * Check if the given clear-text password matches the temporary password
4620 * sent by e-mail for password reset operations.
4622 * @deprecated since 1.27, use AuthManager instead
4623 * @param string $plaintext
4624 * @return bool True if matches, false otherwise
4626 public function checkTemporaryPassword( $plaintext ) {
4627 // Can't check the temporary password individually.
4628 return $this->checkPassword( $plaintext );
4632 * Initialize (if necessary) and return a session token value
4633 * which can be used in edit forms to show that the user's
4634 * login credentials aren't being hijacked with a foreign form
4638 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4639 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4640 * @return MediaWiki\Session\Token The new edit token
4642 public function getEditTokenObject( $salt = '', $request = null ) {
4643 if ( $this->isAnon() ) {
4644 return new LoggedOutEditToken();
4648 $request = $this->getRequest();
4650 return $request->getSession()->getToken( $salt );
4654 * Initialize (if necessary) and return a session token value
4655 * which can be used in edit forms to show that the user's
4656 * login credentials aren't being hijacked with a foreign form
4659 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4662 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4663 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4664 * @return string The new edit token
4666 public function getEditToken( $salt = '', $request = null ) {
4667 return $this->getEditTokenObject( $salt, $request )->toString();
4671 * Get the embedded timestamp from a token.
4672 * @deprecated since 1.27, use \MediaWiki\Session\Token::getTimestamp instead.
4673 * @param string $val Input token
4676 public static function getEditTokenTimestamp( $val ) {
4677 wfDeprecated( __METHOD__
, '1.27' );
4678 return MediaWiki\Session\Token
::getTimestamp( $val );
4682 * Check given value against the token value stored in the session.
4683 * A match should confirm that the form was submitted from the
4684 * user's own login session, not a form submission from a third-party
4687 * @param string $val Input value to compare
4688 * @param string $salt Optional function-specific data for hashing
4689 * @param WebRequest|null $request Object to use or null to use $wgRequest
4690 * @param int $maxage Fail tokens older than this, in seconds
4691 * @return bool Whether the token matches
4693 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4694 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4698 * Check given value against the token value stored in the session,
4699 * ignoring the suffix.
4701 * @param string $val Input value to compare
4702 * @param string $salt Optional function-specific data for hashing
4703 * @param WebRequest|null $request Object to use or null to use $wgRequest
4704 * @param int $maxage Fail tokens older than this, in seconds
4705 * @return bool Whether the token matches
4707 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4708 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4709 return $this->matchEditToken( $val, $salt, $request, $maxage );
4713 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4714 * mail to the user's given address.
4716 * @param string $type Message to send, either "created", "changed" or "set"
4719 public function sendConfirmationMail( $type = 'created' ) {
4721 $expiration = null; // gets passed-by-ref and defined in next line.
4722 $token = $this->confirmationToken( $expiration );
4723 $url = $this->confirmationTokenUrl( $token );
4724 $invalidateURL = $this->invalidationTokenUrl( $token );
4725 $this->saveSettings();
4727 if ( $type == 'created' ||
$type === false ) {
4728 $message = 'confirmemail_body';
4729 } elseif ( $type === true ) {
4730 $message = 'confirmemail_body_changed';
4732 // Messages: confirmemail_body_changed, confirmemail_body_set
4733 $message = 'confirmemail_body_' . $type;
4736 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4737 wfMessage( $message,
4738 $this->getRequest()->getIP(),
4741 $wgLang->userTimeAndDate( $expiration, $this ),
4743 $wgLang->userDate( $expiration, $this ),
4744 $wgLang->userTime( $expiration, $this ) )->text() );
4748 * Send an e-mail to this user's account. Does not check for
4749 * confirmed status or validity.
4751 * @param string $subject Message subject
4752 * @param string $body Message body
4753 * @param User|null $from Optional sending user; if unspecified, default
4754 * $wgPasswordSender will be used.
4755 * @param string $replyto Reply-To address
4758 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4759 global $wgPasswordSender;
4761 if ( $from instanceof User
) {
4762 $sender = MailAddress
::newFromUser( $from );
4764 $sender = new MailAddress( $wgPasswordSender,
4765 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4767 $to = MailAddress
::newFromUser( $this );
4769 return UserMailer
::send( $to, $sender, $subject, $body, [
4770 'replyTo' => $replyto,
4775 * Generate, store, and return a new e-mail confirmation code.
4776 * A hash (unsalted, since it's used as a key) is stored.
4778 * @note Call saveSettings() after calling this function to commit
4779 * this change to the database.
4781 * @param string &$expiration Accepts the expiration time
4782 * @return string New token
4784 protected function confirmationToken( &$expiration ) {
4785 global $wgUserEmailConfirmationTokenExpiry;
4787 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4788 $expiration = wfTimestamp( TS_MW
, $expires );
4790 $token = MWCryptRand
::generateHex( 32 );
4791 $hash = md5( $token );
4792 $this->mEmailToken
= $hash;
4793 $this->mEmailTokenExpires
= $expiration;
4798 * Return a URL the user can use to confirm their email address.
4799 * @param string $token Accepts the email confirmation token
4800 * @return string New token URL
4802 protected function confirmationTokenUrl( $token ) {
4803 return $this->getTokenUrl( 'ConfirmEmail', $token );
4807 * Return a URL the user can use to invalidate their email address.
4808 * @param string $token Accepts the email confirmation token
4809 * @return string New token URL
4811 protected function invalidationTokenUrl( $token ) {
4812 return $this->getTokenUrl( 'InvalidateEmail', $token );
4816 * Internal function to format the e-mail validation/invalidation URLs.
4817 * This uses a quickie hack to use the
4818 * hardcoded English names of the Special: pages, for ASCII safety.
4820 * @note Since these URLs get dropped directly into emails, using the
4821 * short English names avoids insanely long URL-encoded links, which
4822 * also sometimes can get corrupted in some browsers/mailers
4823 * (T8957 with Gmail and Internet Explorer).
4825 * @param string $page Special page
4826 * @param string $token
4827 * @return string Formatted URL
4829 protected function getTokenUrl( $page, $token ) {
4830 // Hack to bypass localization of 'Special:'
4831 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4832 return $title->getCanonicalURL();
4836 * Mark the e-mail address confirmed.
4838 * @note Call saveSettings() after calling this function to commit the change.
4842 public function confirmEmail() {
4843 // Check if it's already confirmed, so we don't touch the database
4844 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4845 if ( !$this->isEmailConfirmed() ) {
4846 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4847 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4853 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4854 * address if it was already confirmed.
4856 * @note Call saveSettings() after calling this function to commit the change.
4857 * @return bool Returns true
4859 public function invalidateEmail() {
4861 $this->mEmailToken
= null;
4862 $this->mEmailTokenExpires
= null;
4863 $this->setEmailAuthenticationTimestamp( null );
4865 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4870 * Set the e-mail authentication timestamp.
4871 * @param string $timestamp TS_MW timestamp
4873 public function setEmailAuthenticationTimestamp( $timestamp ) {
4875 $this->mEmailAuthenticated
= $timestamp;
4876 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4880 * Is this user allowed to send e-mails within limits of current
4881 * site configuration?
4884 public function canSendEmail() {
4885 global $wgEnableEmail, $wgEnableUserEmail;
4886 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4889 $canSend = $this->isEmailConfirmed();
4890 // Avoid PHP 7.1 warning of passing $this by reference
4892 Hooks
::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
4897 * Is this user allowed to receive e-mails within limits of current
4898 * site configuration?
4901 public function canReceiveEmail() {
4902 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4906 * Is this user's e-mail address valid-looking and confirmed within
4907 * limits of the current site configuration?
4909 * @note If $wgEmailAuthentication is on, this may require the user to have
4910 * confirmed their address by returning a code or using a password
4911 * sent to the address from the wiki.
4915 public function isEmailConfirmed() {
4916 global $wgEmailAuthentication;
4918 // Avoid PHP 7.1 warning of passing $this by reference
4921 if ( Hooks
::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
4922 if ( $this->isAnon() ) {
4925 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4928 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4938 * Check whether there is an outstanding request for e-mail confirmation.
4941 public function isEmailConfirmationPending() {
4942 global $wgEmailAuthentication;
4943 return $wgEmailAuthentication &&
4944 !$this->isEmailConfirmed() &&
4945 $this->mEmailToken
&&
4946 $this->mEmailTokenExpires
> wfTimestamp();
4950 * Get the timestamp of account creation.
4952 * @return string|bool|null Timestamp of account creation, false for
4953 * non-existent/anonymous user accounts, or null if existing account
4954 * but information is not in database.
4956 public function getRegistration() {
4957 if ( $this->isAnon() ) {
4961 return $this->mRegistration
;
4965 * Get the timestamp of the first edit
4967 * @return string|bool Timestamp of first edit, or false for
4968 * non-existent/anonymous user accounts.
4970 public function getFirstEditTimestamp() {
4971 if ( $this->getId() == 0 ) {
4972 return false; // anons
4974 $dbr = wfGetDB( DB_REPLICA
);
4975 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
4976 $time = $dbr->selectField(
4977 [ 'revision' ] +
$actorWhere['tables'],
4979 [ $actorWhere['conds'] ],
4981 [ 'ORDER BY' => 'rev_timestamp ASC' ],
4982 $actorWhere['joins']
4985 return false; // no edits
4987 return wfTimestamp( TS_MW
, $time );
4991 * Get the permissions associated with a given list of groups
4993 * @param array $groups Array of Strings List of internal group names
4994 * @return array Array of Strings List of permission key names for given groups combined
4996 public static function getGroupPermissions( $groups ) {
4997 global $wgGroupPermissions, $wgRevokePermissions;
4999 // grant every granted permission first
5000 foreach ( $groups as $group ) {
5001 if ( isset( $wgGroupPermissions[$group] ) ) {
5002 $rights = array_merge( $rights,
5003 // array_filter removes empty items
5004 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
5007 // now revoke the revoked permissions
5008 foreach ( $groups as $group ) {
5009 if ( isset( $wgRevokePermissions[$group] ) ) {
5010 $rights = array_diff( $rights,
5011 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
5014 return array_unique( $rights );
5018 * Get all the groups who have a given permission
5020 * @param string $role Role to check
5021 * @return array Array of Strings List of internal group names with the given permission
5023 public static function getGroupsWithPermission( $role ) {
5024 global $wgGroupPermissions;
5025 $allowedGroups = [];
5026 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
5027 if ( self
::groupHasPermission( $group, $role ) ) {
5028 $allowedGroups[] = $group;
5031 return $allowedGroups;
5035 * Check, if the given group has the given permission
5037 * If you're wanting to check whether all users have a permission, use
5038 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
5042 * @param string $group Group to check
5043 * @param string $role Role to check
5046 public static function groupHasPermission( $group, $role ) {
5047 global $wgGroupPermissions, $wgRevokePermissions;
5048 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
5049 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
5053 * Check if all users may be assumed to have the given permission
5055 * We generally assume so if the right is granted to '*' and isn't revoked
5056 * on any group. It doesn't attempt to take grants or other extension
5057 * limitations on rights into account in the general case, though, as that
5058 * would require it to always return false and defeat the purpose.
5059 * Specifically, session-based rights restrictions (such as OAuth or bot
5060 * passwords) are applied based on the current session.
5063 * @param string $right Right to check
5066 public static function isEveryoneAllowed( $right ) {
5067 global $wgGroupPermissions, $wgRevokePermissions;
5070 // Use the cached results, except in unit tests which rely on
5071 // being able change the permission mid-request
5072 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
5073 return $cache[$right];
5076 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
5077 $cache[$right] = false;
5081 // If it's revoked anywhere, then everyone doesn't have it
5082 foreach ( $wgRevokePermissions as $rights ) {
5083 if ( isset( $rights[$right] ) && $rights[$right] ) {
5084 $cache[$right] = false;
5089 // Remove any rights that aren't allowed to the global-session user,
5090 // unless there are no sessions for this endpoint.
5091 if ( !defined( 'MW_NO_SESSION' ) ) {
5092 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
5093 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
5094 $cache[$right] = false;
5099 // Allow extensions to say false
5100 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
5101 $cache[$right] = false;
5105 $cache[$right] = true;
5110 * Get the localized descriptive name for a group, if it exists
5111 * @deprecated since 1.29 Use UserGroupMembership::getGroupName instead
5113 * @param string $group Internal group name
5114 * @return string Localized descriptive group name
5116 public static function getGroupName( $group ) {
5117 wfDeprecated( __METHOD__
, '1.29' );
5118 return UserGroupMembership
::getGroupName( $group );
5122 * Get the localized descriptive name for a member of a group, if it exists
5123 * @deprecated since 1.29 Use UserGroupMembership::getGroupMemberName instead
5125 * @param string $group Internal group name
5126 * @param string $username Username for gender (since 1.19)
5127 * @return string Localized name for group member
5129 public static function getGroupMember( $group, $username = '#' ) {
5130 wfDeprecated( __METHOD__
, '1.29' );
5131 return UserGroupMembership
::getGroupMemberName( $group, $username );
5135 * Return the set of defined explicit groups.
5136 * The implicit groups (by default *, 'user' and 'autoconfirmed')
5137 * are not included, as they are defined automatically, not in the database.
5138 * @return array Array of internal group names
5140 public static function getAllGroups() {
5141 global $wgGroupPermissions, $wgRevokePermissions;
5143 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
5144 self
::getImplicitGroups()
5149 * Get a list of all available permissions.
5150 * @return string[] Array of permission names
5152 public static function getAllRights() {
5153 if ( self
::$mAllRights === false ) {
5154 global $wgAvailableRights;
5155 if ( count( $wgAvailableRights ) ) {
5156 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
5158 self
::$mAllRights = self
::$mCoreRights;
5160 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
5162 return self
::$mAllRights;
5166 * Get a list of implicit groups
5167 * @return array Array of Strings Array of internal group names
5169 public static function getImplicitGroups() {
5170 global $wgImplicitGroups;
5172 $groups = $wgImplicitGroups;
5173 # Deprecated, use $wgImplicitGroups instead
5174 Hooks
::run( 'UserGetImplicitGroups', [ &$groups ], '1.25' );
5180 * Get the title of a page describing a particular group
5181 * @deprecated since 1.29 Use UserGroupMembership::getGroupPage instead
5183 * @param string $group Internal group name
5184 * @return Title|bool Title of the page if it exists, false otherwise
5186 public static function getGroupPage( $group ) {
5187 wfDeprecated( __METHOD__
, '1.29' );
5188 return UserGroupMembership
::getGroupPage( $group );
5192 * Create a link to the group in HTML, if available;
5193 * else return the group name.
5194 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5195 * make the link yourself if you need custom text
5197 * @param string $group Internal name of the group
5198 * @param string $text The text of the link
5199 * @return string HTML link to the group
5201 public static function makeGroupLinkHTML( $group, $text = '' ) {
5202 wfDeprecated( __METHOD__
, '1.29' );
5204 if ( $text == '' ) {
5205 $text = UserGroupMembership
::getGroupName( $group );
5207 $title = UserGroupMembership
::getGroupPage( $group );
5209 return MediaWikiServices
::getInstance()
5210 ->getLinkRenderer()->makeLink( $title, $text );
5212 return htmlspecialchars( $text );
5217 * Create a link to the group in Wikitext, if available;
5218 * else return the group name.
5219 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5220 * make the link yourself if you need custom text
5222 * @param string $group Internal name of the group
5223 * @param string $text The text of the link
5224 * @return string Wikilink to the group
5226 public static function makeGroupLinkWiki( $group, $text = '' ) {
5227 wfDeprecated( __METHOD__
, '1.29' );
5229 if ( $text == '' ) {
5230 $text = UserGroupMembership
::getGroupName( $group );
5232 $title = UserGroupMembership
::getGroupPage( $group );
5234 $page = $title->getFullText();
5235 return "[[$page|$text]]";
5242 * Returns an array of the groups that a particular group can add/remove.
5244 * @param string $group The group to check for whether it can add/remove
5245 * @return array Array( 'add' => array( addablegroups ),
5246 * 'remove' => array( removablegroups ),
5247 * 'add-self' => array( addablegroups to self),
5248 * 'remove-self' => array( removable groups from self) )
5250 public static function changeableByGroup( $group ) {
5251 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
5260 if ( empty( $wgAddGroups[$group] ) ) {
5261 // Don't add anything to $groups
5262 } elseif ( $wgAddGroups[$group] === true ) {
5263 // You get everything
5264 $groups['add'] = self
::getAllGroups();
5265 } elseif ( is_array( $wgAddGroups[$group] ) ) {
5266 $groups['add'] = $wgAddGroups[$group];
5269 // Same thing for remove
5270 if ( empty( $wgRemoveGroups[$group] ) ) {
5272 } elseif ( $wgRemoveGroups[$group] === true ) {
5273 $groups['remove'] = self
::getAllGroups();
5274 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
5275 $groups['remove'] = $wgRemoveGroups[$group];
5278 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
5279 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
5280 foreach ( $wgGroupsAddToSelf as $key => $value ) {
5281 if ( is_int( $key ) ) {
5282 $wgGroupsAddToSelf['user'][] = $value;
5287 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
5288 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
5289 if ( is_int( $key ) ) {
5290 $wgGroupsRemoveFromSelf['user'][] = $value;
5295 // Now figure out what groups the user can add to him/herself
5296 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
5298 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
5299 // No idea WHY this would be used, but it's there
5300 $groups['add-self'] = self
::getAllGroups();
5301 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
5302 $groups['add-self'] = $wgGroupsAddToSelf[$group];
5305 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
5307 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
5308 $groups['remove-self'] = self
::getAllGroups();
5309 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
5310 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
5317 * Returns an array of groups that this user can add and remove
5318 * @return array Array( 'add' => array( addablegroups ),
5319 * 'remove' => array( removablegroups ),
5320 * 'add-self' => array( addablegroups to self),
5321 * 'remove-self' => array( removable groups from self) )
5323 public function changeableGroups() {
5324 if ( $this->isAllowed( 'userrights' ) ) {
5325 // This group gives the right to modify everything (reverse-
5326 // compatibility with old "userrights lets you change
5328 // Using array_merge to make the groups reindexed
5329 $all = array_merge( self
::getAllGroups() );
5338 // Okay, it's not so simple, we will have to go through the arrays
5345 $addergroups = $this->getEffectiveGroups();
5347 foreach ( $addergroups as $addergroup ) {
5348 $groups = array_merge_recursive(
5349 $groups, $this->changeableByGroup( $addergroup )
5351 $groups['add'] = array_unique( $groups['add'] );
5352 $groups['remove'] = array_unique( $groups['remove'] );
5353 $groups['add-self'] = array_unique( $groups['add-self'] );
5354 $groups['remove-self'] = array_unique( $groups['remove-self'] );
5360 * Deferred version of incEditCountImmediate()
5362 * This function, rather than incEditCountImmediate(), should be used for
5363 * most cases as it avoids potential deadlocks caused by concurrent editing.
5365 public function incEditCount() {
5366 wfGetDB( DB_MASTER
)->onTransactionPreCommitOrIdle(
5368 $this->incEditCountImmediate();
5375 * Increment the user's edit-count field.
5376 * Will have no effect for anonymous users.
5379 public function incEditCountImmediate() {
5380 if ( $this->isAnon() ) {
5384 $dbw = wfGetDB( DB_MASTER
);
5385 // No rows will be "affected" if user_editcount is NULL
5388 [ 'user_editcount=user_editcount+1' ],
5389 [ 'user_id' => $this->getId(), 'user_editcount IS NOT NULL' ],
5392 // Lazy initialization check...
5393 if ( $dbw->affectedRows() == 0 ) {
5394 // Now here's a goddamn hack...
5395 $dbr = wfGetDB( DB_REPLICA
);
5396 if ( $dbr !== $dbw ) {
5397 // If we actually have a replica DB server, the count is
5398 // at least one behind because the current transaction
5399 // has not been committed and replicated.
5400 $this->mEditCount
= $this->initEditCount( 1 );
5402 // But if DB_REPLICA is selecting the master, then the
5403 // count we just read includes the revision that was
5404 // just added in the working transaction.
5405 $this->mEditCount
= $this->initEditCount();
5408 if ( $this->mEditCount
=== null ) {
5409 $this->getEditCount();
5410 $dbr = wfGetDB( DB_REPLICA
);
5411 $this->mEditCount +
= ( $dbr !== $dbw ) ?
1 : 0;
5413 $this->mEditCount++
;
5416 // Edit count in user cache too
5417 $this->invalidateCache();
5421 * Initialize user_editcount from data out of the revision table
5423 * @param int $add Edits to add to the count from the revision table
5424 * @return int Number of edits
5426 protected function initEditCount( $add = 0 ) {
5427 // Pull from a replica DB to be less cruel to servers
5428 // Accuracy isn't the point anyway here
5429 $dbr = wfGetDB( DB_REPLICA
);
5430 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5431 $count = (int)$dbr->selectField(
5432 [ 'revision' ] +
$actorWhere['tables'],
5434 [ $actorWhere['conds'] ],
5437 $actorWhere['joins']
5439 $count = $count +
$add;
5441 $dbw = wfGetDB( DB_MASTER
);
5444 [ 'user_editcount' => $count ],
5445 [ 'user_id' => $this->getId() ],
5453 * Get the description of a given right
5456 * @param string $right Right to query
5457 * @return string Localized description of the right
5459 public static function getRightDescription( $right ) {
5460 $key = "right-$right";
5461 $msg = wfMessage( $key );
5462 return $msg->isDisabled() ?
$right : $msg->text();
5466 * Get the name of a given grant
5469 * @param string $grant Grant to query
5470 * @return string Localized name of the grant
5472 public static function getGrantName( $grant ) {
5473 $key = "grant-$grant";
5474 $msg = wfMessage( $key );
5475 return $msg->isDisabled() ?
$grant : $msg->text();
5479 * Add a newuser log entry for this user.
5480 * Before 1.19 the return value was always true.
5482 * @deprecated since 1.27, AuthManager handles logging
5483 * @param string|bool $action Account creation type.
5484 * - String, one of the following values:
5485 * - 'create' for an anonymous user creating an account for himself.
5486 * This will force the action's performer to be the created user itself,
5487 * no matter the value of $wgUser
5488 * - 'create2' for a logged in user creating an account for someone else
5489 * - 'byemail' when the created user will receive its password by e-mail
5490 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5491 * - Boolean means whether the account was created by e-mail (deprecated):
5492 * - true will be converted to 'byemail'
5493 * - false will be converted to 'create' if this object is the same as
5494 * $wgUser and to 'create2' otherwise
5495 * @param string $reason User supplied reason
5498 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5499 return true; // disabled
5503 * Add an autocreate newuser log entry for this user
5504 * Used by things like CentralAuth and perhaps other authplugins.
5505 * Consider calling addNewUserLogEntry() directly instead.
5507 * @deprecated since 1.27, AuthManager handles logging
5510 public function addNewUserLogEntryAutoCreate() {
5511 $this->addNewUserLogEntry( 'autocreate' );
5517 * Load the user options either from cache, the database or an array
5519 * @param array $data Rows for the current user out of the user_properties table
5521 protected function loadOptions( $data = null ) {
5526 if ( $this->mOptionsLoaded
) {
5530 $this->mOptions
= self
::getDefaultOptions();
5532 if ( !$this->getId() ) {
5533 // For unlogged-in users, load language/variant options from request.
5534 // There's no need to do it for logged-in users: they can set preferences,
5535 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5536 // so don't override user's choice (especially when the user chooses site default).
5537 $variant = $wgContLang->getDefaultVariant();
5538 $this->mOptions
['variant'] = $variant;
5539 $this->mOptions
['language'] = $variant;
5540 $this->mOptionsLoaded
= true;
5544 // Maybe load from the object
5545 if ( !is_null( $this->mOptionOverrides
) ) {
5546 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5547 foreach ( $this->mOptionOverrides
as $key => $value ) {
5548 $this->mOptions
[$key] = $value;
5551 if ( !is_array( $data ) ) {
5552 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5553 // Load from database
5554 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5555 ?
wfGetDB( DB_MASTER
)
5556 : wfGetDB( DB_REPLICA
);
5558 $res = $dbr->select(
5560 [ 'up_property', 'up_value' ],
5561 [ 'up_user' => $this->getId() ],
5565 $this->mOptionOverrides
= [];
5567 foreach ( $res as $row ) {
5568 // Convert '0' to 0. PHP's boolean conversion considers them both
5569 // false, but e.g. JavaScript considers the former as true.
5570 // @todo: T54542 Somehow determine the desired type (string/int/bool)
5571 // and convert all values here.
5572 if ( $row->up_value
=== '0' ) {
5575 $data[$row->up_property
] = $row->up_value
;
5579 // Convert the email blacklist from a new line delimited string
5580 // to an array of ids.
5581 if ( isset( $data['email-blacklist'] ) && $data['email-blacklist'] ) {
5582 $data['email-blacklist'] = array_map( 'intval', explode( "\n", $data['email-blacklist'] ) );
5585 foreach ( $data as $property => $value ) {
5586 $this->mOptionOverrides
[$property] = $value;
5587 $this->mOptions
[$property] = $value;
5591 $this->mOptionsLoaded
= true;
5593 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5597 * Saves the non-default options for this user, as previously set e.g. via
5598 * setOption(), in the database's "user_properties" (preferences) table.
5599 * Usually used via saveSettings().
5601 protected function saveOptions() {
5602 $this->loadOptions();
5604 // Not using getOptions(), to keep hidden preferences in database
5605 $saveOptions = $this->mOptions
;
5607 // Convert usernames to ids.
5608 if ( isset( $this->mOptions
['email-blacklist'] ) ) {
5609 if ( $this->mOptions
['email-blacklist'] ) {
5610 $value = $this->mOptions
['email-blacklist'];
5611 // Email Blacklist may be an array of ids or a string of new line
5612 // delimnated user names.
5613 if ( is_array( $value ) ) {
5614 $ids = array_filter( $value, 'is_numeric' );
5616 $lookup = CentralIdLookup
::factory();
5617 $ids = $lookup->centralIdsFromNames( explode( "\n", $value ), $this );
5619 $this->mOptions
['email-blacklist'] = $ids;
5620 $saveOptions['email-blacklist'] = implode( "\n", $this->mOptions
['email-blacklist'] );
5622 // If the blacklist is empty, set it to null rather than an empty string.
5623 $this->mOptions
['email-blacklist'] = null;
5627 // Allow hooks to abort, for instance to save to a global profile.
5628 // Reset options to default state before saving.
5629 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5633 $userId = $this->getId();
5635 $insert_rows = []; // all the new preference rows
5636 foreach ( $saveOptions as $key => $value ) {
5637 // Don't bother storing default values
5638 $defaultOption = self
::getDefaultOption( $key );
5639 if ( ( $defaultOption === null && $value !== false && $value !== null )
5640 ||
$value != $defaultOption
5643 'up_user' => $userId,
5644 'up_property' => $key,
5645 'up_value' => $value,
5650 $dbw = wfGetDB( DB_MASTER
);
5652 $res = $dbw->select( 'user_properties',
5653 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5655 // Find prior rows that need to be removed or updated. These rows will
5656 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5658 foreach ( $res as $row ) {
5659 if ( !isset( $saveOptions[$row->up_property
] )
5660 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5662 $keysDelete[] = $row->up_property
;
5666 if ( count( $keysDelete ) ) {
5667 // Do the DELETE by PRIMARY KEY for prior rows.
5668 // In the past a very large portion of calls to this function are for setting
5669 // 'rememberpassword' for new accounts (a preference that has since been removed).
5670 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5671 // caused gap locks on [max user ID,+infinity) which caused high contention since
5672 // updates would pile up on each other as they are for higher (newer) user IDs.
5673 // It might not be necessary these days, but it shouldn't hurt either.
5674 $dbw->delete( 'user_properties',
5675 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5677 // Insert the new preference rows
5678 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5682 * Lazily instantiate and return a factory object for making passwords
5684 * @deprecated since 1.27, create a PasswordFactory directly instead
5685 * @return PasswordFactory
5687 public static function getPasswordFactory() {
5688 wfDeprecated( __METHOD__
, '1.27' );
5689 $ret = new PasswordFactory();
5690 $ret->init( RequestContext
::getMain()->getConfig() );
5695 * Provide an array of HTML5 attributes to put on an input element
5696 * intended for the user to enter a new password. This may include
5697 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
5699 * Do *not* use this when asking the user to enter his current password!
5700 * Regardless of configuration, users may have invalid passwords for whatever
5701 * reason (e.g., they were set before requirements were tightened up).
5702 * Only use it when asking for a new password, like on account creation or
5705 * Obviously, you still need to do server-side checking.
5707 * NOTE: A combination of bugs in various browsers means that this function
5708 * actually just returns array() unconditionally at the moment. May as
5709 * well keep it around for when the browser bugs get fixed, though.
5711 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
5713 * @deprecated since 1.27
5714 * @return array Array of HTML attributes suitable for feeding to
5715 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
5716 * That will get confused by the boolean attribute syntax used.)
5718 public static function passwordChangeInputAttribs() {
5719 global $wgMinimalPasswordLength;
5721 if ( $wgMinimalPasswordLength == 0 ) {
5725 # Note that the pattern requirement will always be satisfied if the
5726 # input is empty, so we need required in all cases.
5728 # @todo FIXME: T25769: This needs to not claim the password is required
5729 # if e-mail confirmation is being used. Since HTML5 input validation
5730 # is b0rked anyway in some browsers, just return nothing. When it's
5731 # re-enabled, fix this code to not output required for e-mail
5733 # $ret = array( 'required' );
5736 # We can't actually do this right now, because Opera 9.6 will print out
5737 # the entered password visibly in its error message! When other
5738 # browsers add support for this attribute, or Opera fixes its support,
5739 # we can add support with a version check to avoid doing this on Opera
5740 # versions where it will be a problem. Reported to Opera as
5741 # DSK-262266, but they don't have a public bug tracker for us to follow.
5743 if ( $wgMinimalPasswordLength > 1 ) {
5744 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
5745 $ret['title'] = wfMessage( 'passwordtooshort' )
5746 ->numParams( $wgMinimalPasswordLength )->text();
5754 * Return the list of user fields that should be selected to create
5755 * a new user object.
5756 * @deprecated since 1.31, use self::getQueryInfo() instead.
5759 public static function selectFields() {
5760 wfDeprecated( __METHOD__
, '1.31' );
5768 'user_email_authenticated',
5770 'user_email_token_expires',
5771 'user_registration',
5777 * Return the tables, fields, and join conditions to be selected to create
5778 * a new user object.
5780 * @return array With three keys:
5781 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
5782 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
5783 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
5785 public static function getQueryInfo() {
5786 global $wgActorTableSchemaMigrationStage;
5789 'tables' => [ 'user' ],
5797 'user_email_authenticated',
5799 'user_email_token_expires',
5800 'user_registration',
5805 if ( $wgActorTableSchemaMigrationStage > MIGRATION_OLD
) {
5806 $ret['tables']['user_actor'] = 'actor';
5807 $ret['fields'][] = 'user_actor.actor_id';
5808 $ret['joins']['user_actor'] = [
5809 $wgActorTableSchemaMigrationStage === MIGRATION_NEW ?
'JOIN' : 'LEFT JOIN',
5810 [ 'user_actor.actor_user = user_id' ]
5817 * Factory function for fatal permission-denied errors
5820 * @param string $permission User right required
5823 static function newFatalPermissionDeniedStatus( $permission ) {
5827 foreach ( self
::getGroupsWithPermission( $permission ) as $group ) {
5828 $groups[] = UserGroupMembership
::getLink( $group, RequestContext
::getMain(), 'wiki' );
5832 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5834 return Status
::newFatal( 'badaccess-group0' );
5839 * Get a new instance of this user that was loaded from the master via a locking read
5841 * Use this instead of the main context User when updating that user. This avoids races
5842 * where that user was loaded from a replica DB or even the master but without proper locks.
5844 * @return User|null Returns null if the user was not found in the DB
5847 public function getInstanceForUpdate() {
5848 if ( !$this->getId() ) {
5849 return null; // anon
5852 $user = self
::newFromId( $this->getId() );
5853 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5861 * Checks if two user objects point to the same user.
5867 public function equals( User
$user ) {
5868 return $this->getName() === $user->getName();