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\Block\AbstractBlock
;
24 use MediaWiki\Block\DatabaseBlock
;
25 use MediaWiki\Block\SystemBlock
;
26 use MediaWiki\MediaWikiServices
;
27 use MediaWiki\Session\SessionManager
;
28 use MediaWiki\Session\Token
;
29 use MediaWiki\Auth\AuthManager
;
30 use MediaWiki\Auth\AuthenticationResponse
;
31 use MediaWiki\Auth\AuthenticationRequest
;
32 use MediaWiki\User\UserIdentity
;
33 use MediaWiki\Logger\LoggerFactory
;
34 use Wikimedia\Assert\Assert
;
36 use Wikimedia\ScopedCallback
;
37 use Wikimedia\Rdbms\Database
;
38 use Wikimedia\Rdbms\DBExpectedError
;
39 use Wikimedia\Rdbms\IDatabase
;
42 * The User object encapsulates all of the user-specific settings (user_id,
43 * name, rights, email address, options, last login time). Client
44 * classes use the getXXX() functions to access these fields. These functions
45 * do all the work of determining whether the user is logged in,
46 * whether the requested option can be satisfied from cookies or
47 * whether a database query is needed. Most of the settings needed
48 * for rendering normal pages are set in the cookie to minimize use
51 class User
implements IDBAccessObject
, UserIdentity
{
54 * Number of characters required for the user_token field.
56 const TOKEN_LENGTH
= 32;
59 * An invalid string value for the user_token field.
61 const INVALID_TOKEN
= '*** INVALID ***';
64 * Version number to tag cached versions of serialized User objects. Should be increased when
65 * {@link $mCacheVars} or one of it's members changes.
70 * Exclude user options that are set to their default value.
73 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
78 const CHECK_USER_RIGHTS
= true;
83 const IGNORE_USER_RIGHTS
= false;
86 * Array of Strings List of member variables which are saved to the
87 * shared cache (memcached). Any operation which changes the
88 * corresponding database fields must call a cache-clearing function.
92 protected static $mCacheVars = [
100 'mEmailAuthenticated',
102 'mEmailTokenExpires',
107 // user_properties table
113 /** Cache variables */
126 /** @var string TS_MW timestamp from the DB */
128 /** @var string TS_MW timestamp from cache */
129 protected $mQuickTouched;
133 public $mEmailAuthenticated;
135 protected $mEmailToken;
137 protected $mEmailTokenExpires;
139 protected $mRegistration;
141 protected $mEditCount;
142 /** @var UserGroupMembership[] Associative array of (group name => UserGroupMembership object) */
143 protected $mGroupMemberships;
145 protected $mOptionOverrides;
150 * @var bool Whether the cache variables have been loaded.
152 public $mOptionsLoaded;
155 * @var array|bool Array with already loaded items or true if all items have been loaded.
157 protected $mLoadedItems = [];
161 * @var string Initialization data source if mLoadedItems!==true. May be one of:
162 * - 'defaults' anonymous user initialised from class defaults
163 * - 'name' initialise from mName
164 * - 'id' initialise from mId
165 * - 'actor' initialise from mActorId
166 * - 'session' log in from session if possible
168 * Use the User::newFrom*() family of functions to set this.
173 * Lazy-initialized variables, invalidated with clearInstanceCache
178 protected $mDatePreference;
184 protected $mBlockreason;
186 protected $mEffectiveGroups;
188 protected $mImplicitGroups;
190 protected $mFormerGroups;
191 /** @var AbstractBlock */
192 protected $mGlobalBlock;
200 /** @var WebRequest */
203 /** @var AbstractBlock */
207 protected $mAllowUsertalk;
209 /** @var AbstractBlock|bool */
210 private $mBlockedFromCreateAccount = false;
212 /** @var int User::READ_* constant bitfield used to load data */
213 protected $queryFlagsUsed = self
::READ_NORMAL
;
216 public static $idCacheByName = [];
219 * Lightweight constructor for an anonymous user.
220 * Use the User::newFrom* factory functions for other kinds of users.
224 * @see newFromActorId()
225 * @see newFromConfirmationCode()
226 * @see newFromSession()
229 public function __construct() {
230 $this->clearInstanceCache( 'defaults' );
236 public function __toString() {
237 return (string)$this->getName();
240 public function &__get( $name ) {
241 // A shortcut for $mRights deprecation phase
242 if ( $name === 'mRights' ) {
243 $copy = $this->getRights();
245 } elseif ( !property_exists( $this, $name ) ) {
246 // T227688 - do not break $u->foo['bar'] = 1
247 wfLogWarning( 'tried to get non-existent property' );
251 wfLogWarning( 'tried to get non-visible property' );
257 public function __set( $name, $value ) {
258 // A shortcut for $mRights deprecation phase, only known legitimate use was for
259 // testing purposes, other uses seem bad in principle
260 if ( $name === 'mRights' ) {
261 MediaWikiServices
::getInstance()->getPermissionManager()->overrideUserRightsForTesting(
263 is_null( $value ) ?
[] : $value
265 } elseif ( !property_exists( $this, $name ) ) {
266 $this->$name = $value;
268 wfLogWarning( 'tried to set non-visible property' );
273 * Test if it's safe to load this User object.
275 * You should typically check this before using $wgUser or
276 * RequestContext::getUser in a method that might be called before the
277 * system has been fully initialized. If the object is unsafe, you should
278 * use an anonymous user:
280 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
286 public function isSafeToLoad() {
287 global $wgFullyInitialised;
289 // The user is safe to load if:
290 // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
291 // * mLoadedItems === true (already loaded)
292 // * mFrom !== 'session' (sessions not involved at all)
294 return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
295 $this->mLoadedItems
=== true ||
$this->mFrom
!== 'session';
299 * Load the user table data for this object from the source given by mFrom.
301 * @param int $flags User::READ_* constant bitfield
303 public function load( $flags = self
::READ_NORMAL
) {
304 global $wgFullyInitialised;
306 if ( $this->mLoadedItems
=== true ) {
310 // Set it now to avoid infinite recursion in accessors
311 $oldLoadedItems = $this->mLoadedItems
;
312 $this->mLoadedItems
= true;
313 $this->queryFlagsUsed
= $flags;
315 // If this is called too early, things are likely to break.
316 if ( !$wgFullyInitialised && $this->mFrom
=== 'session' ) {
317 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
318 ->warning( 'User::loadFromSession called before the end of Setup.php', [
319 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
321 $this->loadDefaults();
322 $this->mLoadedItems
= $oldLoadedItems;
326 switch ( $this->mFrom
) {
328 $this->loadDefaults();
331 // Make sure this thread sees its own changes
332 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
333 if ( $lb->hasOrMadeRecentMasterChanges() ) {
334 $flags |
= self
::READ_LATEST
;
335 $this->queryFlagsUsed
= $flags;
338 $this->mId
= self
::idFromName( $this->mName
, $flags );
340 // Nonexistent user placeholder object
341 $this->loadDefaults( $this->mName
);
343 $this->loadFromId( $flags );
347 // Make sure this thread sees its own changes, if the ID isn't 0
348 if ( $this->mId
!= 0 ) {
349 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
350 if ( $lb->hasOrMadeRecentMasterChanges() ) {
351 $flags |
= self
::READ_LATEST
;
352 $this->queryFlagsUsed
= $flags;
356 $this->loadFromId( $flags );
359 // Make sure this thread sees its own changes
360 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
361 if ( $lb->hasOrMadeRecentMasterChanges() ) {
362 $flags |
= self
::READ_LATEST
;
363 $this->queryFlagsUsed
= $flags;
366 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
367 $row = wfGetDB( $index )->selectRow(
369 [ 'actor_user', 'actor_name' ],
370 [ 'actor_id' => $this->mActorId
],
377 $this->loadDefaults();
378 } elseif ( $row->actor_user
) {
379 $this->mId
= $row->actor_user
;
380 $this->loadFromId( $flags );
382 $this->loadDefaults( $row->actor_name
);
386 if ( !$this->loadFromSession() ) {
387 // Loading from session failed. Load defaults.
388 $this->loadDefaults();
390 Hooks
::run( 'UserLoadAfterLoadFromSession', [ $this ] );
393 throw new UnexpectedValueException(
394 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
399 * Load user table data, given mId has already been set.
400 * @param int $flags User::READ_* constant bitfield
401 * @return bool False if the ID does not exist, true otherwise
403 public function loadFromId( $flags = self
::READ_NORMAL
) {
404 if ( $this->mId
== 0 ) {
405 // Anonymous users are not in the database (don't need cache)
406 $this->loadDefaults();
410 // Try cache (unless this needs data from the master DB).
411 // NOTE: if this thread called saveSettings(), the cache was cleared.
412 $latest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
414 if ( !$this->loadFromDatabase( $flags ) ) {
415 // Can't load from ID
419 $this->loadFromCache();
422 $this->mLoadedItems
= true;
423 $this->queryFlagsUsed
= $flags;
430 * @param string $dbDomain
433 public static function purge( $dbDomain, $userId ) {
434 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
435 $key = $cache->makeGlobalKey( 'user', 'id', $dbDomain, $userId );
436 $cache->delete( $key );
441 * @param WANObjectCache $cache
444 protected function getCacheKey( WANObjectCache
$cache ) {
445 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
447 return $cache->makeGlobalKey( 'user', 'id', $lbFactory->getLocalDomainID(), $this->mId
);
451 * @param WANObjectCache $cache
455 public function getMutableCacheKeys( WANObjectCache
$cache ) {
456 $id = $this->getId();
458 return $id ?
[ $this->getCacheKey( $cache ) ] : [];
462 * Load user data from shared cache, given mId has already been set.
467 protected function loadFromCache() {
468 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
469 $data = $cache->getWithSetCallback(
470 $this->getCacheKey( $cache ),
472 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
473 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
474 wfDebug( "User: cache miss for user {$this->mId}\n" );
476 $this->loadFromDatabase( self
::READ_NORMAL
);
478 $this->loadOptions();
481 foreach ( self
::$mCacheVars as $name ) {
482 $data[$name] = $this->$name;
485 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->mTouched
), $ttl );
487 // if a user group membership is about to expire, the cache needs to
488 // expire at that time (T163691)
489 foreach ( $this->mGroupMemberships
as $ugm ) {
490 if ( $ugm->getExpiry() ) {
491 $secondsUntilExpiry = wfTimestamp( TS_UNIX
, $ugm->getExpiry() ) - time();
492 if ( $secondsUntilExpiry > 0 && $secondsUntilExpiry < $ttl ) {
493 $ttl = $secondsUntilExpiry;
500 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'version' => self
::VERSION
]
503 // Restore from cache
504 foreach ( self
::$mCacheVars as $name ) {
505 $this->$name = $data[$name];
511 /** @name newFrom*() static factory methods */
515 * Static factory method for creation from username.
517 * This is slightly less efficient than newFromId(), so use newFromId() if
518 * you have both an ID and a name handy.
520 * @param string $name Username, validated by Title::newFromText()
521 * @param string|bool $validate Validate username. Takes the same parameters as
522 * User::getCanonicalName(), except that true is accepted as an alias
523 * for 'valid', for BC.
525 * @return User|bool User object, or false if the username is invalid
526 * (e.g. if it contains illegal characters or is an IP address). If the
527 * username is not present in the database, the result will be a user object
528 * with a name, zero user ID and default settings.
530 public static function newFromName( $name, $validate = 'valid' ) {
531 if ( $validate === true ) {
534 $name = self
::getCanonicalName( $name, $validate );
535 if ( $name === false ) {
539 // Create unloaded user object
543 $u->setItemLoaded( 'name' );
549 * Static factory method for creation from a given user ID.
551 * @param int $id Valid user ID
552 * @return User The corresponding User object
554 public static function newFromId( $id ) {
558 $u->setItemLoaded( 'id' );
563 * Static factory method for creation from a given actor ID.
566 * @param int $id Valid actor ID
567 * @return User The corresponding User object
569 public static function newFromActorId( $id ) {
570 global $wgActorTableSchemaMigrationStage;
572 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
573 // but it does little harm and might be needed for write callers loading a User.
574 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) ) {
575 throw new BadMethodCallException(
576 'Cannot use ' . __METHOD__
577 . ' when $wgActorTableSchemaMigrationStage lacks SCHEMA_COMPAT_NEW'
584 $u->setItemLoaded( 'actor' );
589 * Returns a User object corresponding to the given UserIdentity.
593 * @param UserIdentity $identity
597 public static function newFromIdentity( UserIdentity
$identity ) {
598 if ( $identity instanceof User
) {
602 return self
::newFromAnyId(
603 $identity->getId() === 0 ?
null : $identity->getId(),
604 $identity->getName() === '' ?
null : $identity->getName(),
605 $identity->getActorId() === 0 ?
null : $identity->getActorId()
610 * Static factory method for creation from an ID, name, and/or actor ID
612 * This does not check that the ID, name, and actor ID all correspond to
616 * @param int|null $userId User ID, if known
617 * @param string|null $userName User name, if known
618 * @param int|null $actorId Actor ID, if known
619 * @param bool|string $dbDomain remote wiki to which the User/Actor ID applies, or false if none
622 public static function newFromAnyId( $userId, $userName, $actorId, $dbDomain = false ) {
623 global $wgActorTableSchemaMigrationStage;
625 // Stop-gap solution for the problem described in T222212.
626 // Force the User ID and Actor ID to zero for users loaded from the database
627 // of another wiki, to prevent subtle data corruption and confusing failure modes.
628 if ( $dbDomain !== false ) {
634 $user->mFrom
= 'defaults';
636 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
637 // but it does little harm and might be needed for write callers loading a User.
638 if ( ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) && $actorId !== null ) {
639 $user->mActorId
= (int)$actorId;
640 if ( $user->mActorId
!== 0 ) {
641 $user->mFrom
= 'actor';
643 $user->setItemLoaded( 'actor' );
646 if ( $userName !== null && $userName !== '' ) {
647 $user->mName
= $userName;
648 $user->mFrom
= 'name';
649 $user->setItemLoaded( 'name' );
652 if ( $userId !== null ) {
653 $user->mId
= (int)$userId;
654 if ( $user->mId
!== 0 ) {
657 $user->setItemLoaded( 'id' );
660 if ( $user->mFrom
=== 'defaults' ) {
661 throw new InvalidArgumentException(
662 'Cannot create a user with no name, no ID, and no actor ID'
670 * Factory method to fetch whichever user has a given email confirmation code.
671 * This code is generated when an account is created or its e-mail address
674 * If the code is invalid or has expired, returns NULL.
676 * @param string $code Confirmation code
677 * @param int $flags User::READ_* bitfield
680 public static function newFromConfirmationCode( $code, $flags = 0 ) {
681 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
682 ?
wfGetDB( DB_MASTER
)
683 : wfGetDB( DB_REPLICA
);
685 $id = $db->selectField(
689 'user_email_token' => md5( $code ),
690 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
694 return $id ? self
::newFromId( $id ) : null;
698 * Create a new user object using data from session. If the login
699 * credentials are invalid, the result is an anonymous user.
701 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
704 public static function newFromSession( WebRequest
$request = null ) {
706 $user->mFrom
= 'session';
707 $user->mRequest
= $request;
712 * Create a new user object from a user row.
713 * The row should have the following fields from the user table in it:
714 * - either user_name or user_id to load further data if needed (or both)
716 * - all other fields (email, etc.)
717 * It is useless to provide the remaining fields if either user_id,
718 * user_name and user_real_name are not provided because the whole row
719 * will be loaded once more from the database when accessing them.
721 * @param stdClass $row A row from the user table
722 * @param array|null $data Further data to load into the object
723 * (see User::loadFromRow for valid keys)
726 public static function newFromRow( $row, $data = null ) {
728 $user->loadFromRow( $row, $data );
733 * Static factory method for creation of a "system" user from username.
735 * A "system" user is an account that's used to attribute logged actions
736 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
737 * might include the 'Maintenance script' or 'Conversion script' accounts
738 * used by various scripts in the maintenance/ directory or accounts such
739 * as 'MediaWiki message delivery' used by the MassMessage extension.
741 * This can optionally create the user if it doesn't exist, and "steal" the
742 * account if it does exist.
744 * "Stealing" an existing user is intended to make it impossible for normal
745 * authentication processes to use the account, effectively disabling the
746 * account for normal use:
747 * - Email is invalidated, to prevent account recovery by emailing a
748 * temporary password and to disassociate the account from the existing
750 * - The token is set to a magic invalid value, to kill existing sessions
751 * and to prevent $this->setToken() calls from resetting the token to a
753 * - SessionManager is instructed to prevent new sessions for the user, to
754 * do things like deauthorizing OAuth consumers.
755 * - AuthManager is instructed to revoke access, to invalidate or remove
756 * passwords and other credentials.
758 * @param string $name Username
759 * @param array $options Options are:
760 * - validate: As for User::getCanonicalName(), default 'valid'
761 * - create: Whether to create the user if it doesn't already exist, default true
762 * - steal: Whether to "disable" the account for normal use if it already
763 * exists, default false
767 public static function newSystemUser( $name, $options = [] ) {
769 'validate' => 'valid',
774 $name = self
::getCanonicalName( $name, $options['validate'] );
775 if ( $name === false ) {
779 $dbr = wfGetDB( DB_REPLICA
);
780 $userQuery = self
::getQueryInfo();
781 $row = $dbr->selectRow(
782 $userQuery['tables'],
783 $userQuery['fields'],
784 [ 'user_name' => $name ],
790 // Try the master database...
791 $dbw = wfGetDB( DB_MASTER
);
792 $row = $dbw->selectRow(
793 $userQuery['tables'],
794 $userQuery['fields'],
795 [ 'user_name' => $name ],
803 // No user. Create it?
804 return $options['create']
805 ? self
::createNew( $name, [ 'token' => self
::INVALID_TOKEN
] )
809 $user = self
::newFromRow( $row );
811 // A user is considered to exist as a non-system user if it can
812 // authenticate, or has an email set, or has a non-invalid token.
813 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
814 AuthManager
::singleton()->userCanAuthenticate( $name )
816 // User exists. Steal it?
817 if ( !$options['steal'] ) {
821 AuthManager
::singleton()->revokeAccessForUser( $name );
823 $user->invalidateEmail();
824 $user->mToken
= self
::INVALID_TOKEN
;
825 $user->saveSettings();
826 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
835 * Get the username corresponding to a given user ID
836 * @param int $id User ID
837 * @return string|bool The corresponding username
839 public static function whoIs( $id ) {
840 return UserCache
::singleton()->getProp( $id, 'name' );
844 * Get the real name of a user given their user ID
846 * @param int $id User ID
847 * @return string|bool The corresponding user's real name
849 public static function whoIsReal( $id ) {
850 return UserCache
::singleton()->getProp( $id, 'real_name' );
854 * Get database id given a user name
855 * @param string $name Username
856 * @param int $flags User::READ_* constant bitfield
857 * @return int|null The corresponding user's ID, or null if user is nonexistent
859 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
860 // Don't explode on self::$idCacheByName[$name] if $name is not a string but e.g. a User object
861 $name = (string)$name;
862 $nt = Title
::makeTitleSafe( NS_USER
, $name );
863 if ( is_null( $nt ) ) {
868 if ( !( $flags & self
::READ_LATEST
) && array_key_exists( $name, self
::$idCacheByName ) ) {
869 return is_null( self
::$idCacheByName[$name] ) ?
null : (int)self
::$idCacheByName[$name];
872 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
873 $db = wfGetDB( $index );
878 [ 'user_name' => $nt->getText() ],
883 if ( $s === false ) {
886 $result = (int)$s->user_id
;
889 if ( count( self
::$idCacheByName ) >= 1000 ) {
890 self
::$idCacheByName = [];
893 self
::$idCacheByName[$name] = $result;
899 * Reset the cache used in idFromName(). For use in tests.
901 public static function resetIdByNameCache() {
902 self
::$idCacheByName = [];
906 * Does the string match an anonymous IP address?
908 * This function exists for username validation, in order to reject
909 * usernames which are similar in form to IP addresses. Strings such
910 * as 300.300.300.300 will return true because it looks like an IP
911 * address, despite not being strictly valid.
913 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
914 * address because the usemod software would "cloak" anonymous IP
915 * addresses like this, if we allowed accounts like this to be created
916 * new users could get the old edits of these anonymous users.
918 * @param string $name Name to match
921 public static function isIP( $name ) {
922 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
923 || IP
::isIPv6( $name );
927 * Is the user an IP range?
932 public function isIPRange() {
933 return IP
::isValidRange( $this->mName
);
937 * Is the input a valid username?
939 * Checks if the input is a valid username, we don't want an empty string,
940 * an IP address, anything that contains slashes (would mess up subpages),
941 * is longer than the maximum allowed username size or doesn't begin with
944 * @param string $name Name to match
947 public static function isValidUserName( $name ) {
948 global $wgMaxNameChars;
951 || self
::isIP( $name )
952 ||
strpos( $name, '/' ) !== false
953 ||
strlen( $name ) > $wgMaxNameChars
954 ||
$name != MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name )
959 // Ensure that the name can't be misresolved as a different title,
960 // such as with extra namespace keys at the start.
961 $parsed = Title
::newFromText( $name );
962 if ( is_null( $parsed )
963 ||
$parsed->getNamespace()
964 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
968 // Check an additional blacklist of troublemaker characters.
969 // Should these be merged into the title char list?
970 $unicodeBlacklist = '/[' .
971 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
972 '\x{00a0}' . # non-breaking space
973 '\x{2000}-\x{200f}' . # various whitespace
974 '\x{2028}-\x{202f}' . # breaks and control chars
975 '\x{3000}' . # ideographic space
976 '\x{e000}-\x{f8ff}' . # private use
978 if ( preg_match( $unicodeBlacklist, $name ) ) {
986 * Usernames which fail to pass this function will be blocked
987 * from user login and new account registrations, but may be used
988 * internally by batch processes.
990 * If an account already exists in this form, login will be blocked
991 * by a failure to pass this function.
993 * @param string $name Name to match
996 public static function isUsableName( $name ) {
997 global $wgReservedUsernames;
998 // Must be a valid username, obviously ;)
999 if ( !self
::isValidUserName( $name ) ) {
1003 static $reservedUsernames = false;
1004 if ( !$reservedUsernames ) {
1005 $reservedUsernames = $wgReservedUsernames;
1006 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
1009 // Certain names may be reserved for batch processes.
1010 foreach ( $reservedUsernames as $reserved ) {
1011 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
1012 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->plain();
1014 if ( $reserved == $name ) {
1022 * Return the users who are members of the given group(s). In case of multiple groups,
1023 * users who are members of at least one of them are returned.
1025 * @param string|array $groups A single group name or an array of group names
1026 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
1027 * records; larger values are ignored.
1028 * @param int|null $after ID the user to start after
1029 * @return UserArrayFromResult
1031 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
1032 if ( $groups === [] ) {
1033 return UserArrayFromResult
::newFromIDs( [] );
1036 $groups = array_unique( (array)$groups );
1037 $limit = min( 5000, $limit );
1039 $conds = [ 'ug_group' => $groups ];
1040 if ( $after !== null ) {
1041 $conds[] = 'ug_user > ' . (int)$after;
1044 $dbr = wfGetDB( DB_REPLICA
);
1045 $ids = $dbr->selectFieldValues(
1052 'ORDER BY' => 'ug_user',
1056 return UserArray
::newFromIDs( $ids );
1060 * Usernames which fail to pass this function will be blocked
1061 * from new account registrations, but may be used internally
1062 * either by batch processes or by user accounts which have
1063 * already been created.
1065 * Additional blacklisting may be added here rather than in
1066 * isValidUserName() to avoid disrupting existing accounts.
1068 * @param string $name String to match
1071 public static function isCreatableName( $name ) {
1072 global $wgInvalidUsernameCharacters;
1074 // Ensure that the username isn't longer than 235 bytes, so that
1075 // (at least for the builtin skins) user javascript and css files
1076 // will work. (T25080)
1077 if ( strlen( $name ) > 235 ) {
1078 wfDebugLog( 'username', __METHOD__
.
1079 ": '$name' invalid due to length" );
1083 // Preg yells if you try to give it an empty string
1084 if ( $wgInvalidUsernameCharacters !== '' &&
1085 preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name )
1087 wfDebugLog( 'username', __METHOD__
.
1088 ": '$name' invalid due to wgInvalidUsernameCharacters" );
1092 return self
::isUsableName( $name );
1096 * Is the input a valid password for this user?
1098 * @param string $password Desired password
1101 public function isValidPassword( $password ) {
1102 // simple boolean wrapper for checkPasswordValidity
1103 return $this->checkPasswordValidity( $password )->isGood();
1107 * Check if this is a valid password for this user
1109 * Returns a Status object with a set of messages describing
1110 * problems with the password. If the return status is fatal,
1111 * the action should be refused and the password should not be
1112 * checked at all (this is mainly meant for DoS mitigation).
1113 * If the return value is OK but not good, the password can be checked,
1114 * but the user should not be able to set their password to this.
1115 * The value of the returned Status object will be an array which
1116 * can have the following fields:
1117 * - forceChange (bool): if set to true, the user should not be
1118 * allowed to log with this password unless they change it during
1119 * the login process (see ResetPasswordSecondaryAuthenticationProvider).
1120 * - suggestChangeOnLogin (bool): if set to true, the user should be prompted for
1121 * a password change on login.
1123 * @param string $password Desired password
1127 public function checkPasswordValidity( $password ) {
1128 global $wgPasswordPolicy;
1130 $upp = new UserPasswordPolicy(
1131 $wgPasswordPolicy['policies'],
1132 $wgPasswordPolicy['checks']
1135 $status = Status
::newGood( [] );
1136 $result = false; // init $result to false for the internal checks
1138 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1139 $status->error( $result );
1143 if ( $result === false ) {
1144 $status->merge( $upp->checkUserPassword( $this, $password ), true );
1148 if ( $result === true ) {
1152 $status->error( $result );
1153 return $status; // the isValidPassword hook set a string $result and returned true
1157 * Given unvalidated user input, return a canonical username, or false if
1158 * the username is invalid.
1159 * @param string $name User input
1160 * @param string|bool $validate Type of validation to use:
1161 * - false No validation
1162 * - 'valid' Valid for batch processes
1163 * - 'usable' Valid for batch processes and login
1164 * - 'creatable' Valid for batch processes, login and account creation
1166 * @throws InvalidArgumentException
1167 * @return bool|string
1169 public static function getCanonicalName( $name, $validate = 'valid' ) {
1170 // Force usernames to capital
1171 $name = MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name );
1173 # Reject names containing '#'; these will be cleaned up
1174 # with title normalisation, but then it's too late to
1176 if ( strpos( $name, '#' ) !== false ) {
1180 // Clean up name according to title rules,
1181 // but only when validation is requested (T14654)
1182 $t = ( $validate !== false ) ?
1183 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1184 // Check for invalid titles
1185 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1189 $name = $t->getText();
1191 switch ( $validate ) {
1195 if ( !self
::isValidUserName( $name ) ) {
1200 if ( !self
::isUsableName( $name ) ) {
1205 if ( !self
::isCreatableName( $name ) ) {
1210 throw new InvalidArgumentException(
1211 'Invalid parameter value for $validate in ' . __METHOD__
);
1217 * Set cached properties to default.
1219 * @note This no longer clears uncached lazy-initialised properties;
1220 * the constructor does that instead.
1222 * @param string|bool $name
1224 public function loadDefaults( $name = false ) {
1226 $this->mName
= $name;
1227 $this->mActorId
= null;
1228 $this->mRealName
= '';
1230 $this->mOptionOverrides
= null;
1231 $this->mOptionsLoaded
= false;
1233 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1234 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1235 if ( $loggedOut !== 0 ) {
1236 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1238 $this->mTouched
= '1'; # Allow any pages to be cached
1241 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1242 $this->mEmailAuthenticated
= null;
1243 $this->mEmailToken
= '';
1244 $this->mEmailTokenExpires
= null;
1245 $this->mRegistration
= wfTimestamp( TS_MW
);
1246 $this->mGroupMemberships
= [];
1248 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1252 * Return whether an item has been loaded.
1254 * @param string $item Item to check. Current possibilities:
1258 * @param string $all 'all' to check if the whole object has been loaded
1259 * or any other string to check if only the item is available (e.g.
1263 public function isItemLoaded( $item, $all = 'all' ) {
1264 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1265 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1269 * Set that an item has been loaded
1271 * @param string $item
1273 protected function setItemLoaded( $item ) {
1274 if ( is_array( $this->mLoadedItems
) ) {
1275 $this->mLoadedItems
[$item] = true;
1280 * Load user data from the session.
1282 * @return bool True if the user is logged in, false otherwise.
1284 private function loadFromSession() {
1285 // MediaWiki\Session\Session already did the necessary authentication of the user
1286 // returned here, so just use it if applicable.
1287 $session = $this->getRequest()->getSession();
1288 $user = $session->getUser();
1289 if ( $user->isLoggedIn() ) {
1290 $this->loadFromUserObject( $user );
1292 // If this user is autoblocked, set a cookie to track the block. This has to be done on
1293 // every session load, because an autoblocked editor might not edit again from the same
1294 // IP address after being blocked.
1295 MediaWikiServices
::getInstance()->getBlockManager()->trackBlockWithCookie( $this );
1297 // Other code expects these to be set in the session, so set them.
1298 $session->set( 'wsUserID', $this->getId() );
1299 $session->set( 'wsUserName', $this->getName() );
1300 $session->set( 'wsToken', $this->getToken() );
1309 * Set the 'BlockID' cookie depending on block type and user authentication status.
1311 * @deprecated since 1.34 Use BlockManager::trackBlockWithCookie instead
1313 public function trackBlockWithCookie() {
1314 MediaWikiServices
::getInstance()->getBlockManager()->trackBlockWithCookie( $this );
1318 * Load user and user_group data from the database.
1319 * $this->mId must be set, this is how the user is identified.
1321 * @param int $flags User::READ_* constant bitfield
1322 * @return bool True if the user exists, false if the user is anonymous
1324 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1326 $this->mId
= intval( $this->mId
);
1328 if ( !$this->mId
) {
1329 // Anonymous users are not in the database
1330 $this->loadDefaults();
1334 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1335 $db = wfGetDB( $index );
1337 $userQuery = self
::getQueryInfo();
1338 $s = $db->selectRow(
1339 $userQuery['tables'],
1340 $userQuery['fields'],
1341 [ 'user_id' => $this->mId
],
1347 $this->queryFlagsUsed
= $flags;
1348 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1350 if ( $s !== false ) {
1351 // Initialise user table data
1352 $this->loadFromRow( $s );
1353 $this->mGroupMemberships
= null; // deferred
1354 $this->getEditCount(); // revalidation for nulls
1360 $this->loadDefaults();
1366 * Initialize this object from a row from the user table.
1368 * @param stdClass $row Row from the user table to load.
1369 * @param array|null $data Further user data to load into the object
1371 * user_groups Array of arrays or stdClass result rows out of the user_groups
1372 * table. Previously you were supposed to pass an array of strings
1373 * here, but we also need expiry info nowadays, so an array of
1374 * strings is ignored.
1375 * user_properties Array with properties out of the user_properties table
1377 protected function loadFromRow( $row, $data = null ) {
1378 global $wgActorTableSchemaMigrationStage;
1380 if ( !is_object( $row ) ) {
1381 throw new InvalidArgumentException( '$row must be an object' );
1386 $this->mGroupMemberships
= null; // deferred
1388 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
1389 // but it does little harm and might be needed for write callers loading a User.
1390 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
1391 if ( isset( $row->actor_id
) ) {
1392 $this->mActorId
= (int)$row->actor_id
;
1393 if ( $this->mActorId
!== 0 ) {
1394 $this->mFrom
= 'actor';
1396 $this->setItemLoaded( 'actor' );
1402 if ( isset( $row->user_name
) && $row->user_name
!== '' ) {
1403 $this->mName
= $row->user_name
;
1404 $this->mFrom
= 'name';
1405 $this->setItemLoaded( 'name' );
1410 if ( isset( $row->user_real_name
) ) {
1411 $this->mRealName
= $row->user_real_name
;
1412 $this->setItemLoaded( 'realname' );
1417 if ( isset( $row->user_id
) ) {
1418 $this->mId
= intval( $row->user_id
);
1419 if ( $this->mId
!== 0 ) {
1420 $this->mFrom
= 'id';
1422 $this->setItemLoaded( 'id' );
1427 if ( isset( $row->user_id
) && isset( $row->user_name
) && $row->user_name
!== '' ) {
1428 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1431 if ( isset( $row->user_editcount
) ) {
1432 $this->mEditCount
= $row->user_editcount
;
1437 if ( isset( $row->user_touched
) ) {
1438 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1443 if ( isset( $row->user_token
) ) {
1444 // The definition for the column is binary(32), so trim the NULs
1445 // that appends. The previous definition was char(32), so trim
1447 $this->mToken
= rtrim( $row->user_token
, " \0" );
1448 if ( $this->mToken
=== '' ) {
1449 $this->mToken
= null;
1455 if ( isset( $row->user_email
) ) {
1456 $this->mEmail
= $row->user_email
;
1457 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1458 $this->mEmailToken
= $row->user_email_token
;
1459 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1460 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1466 $this->mLoadedItems
= true;
1469 if ( is_array( $data ) ) {
1470 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1471 if ( $data['user_groups'] === [] ) {
1472 $this->mGroupMemberships
= [];
1474 $firstGroup = reset( $data['user_groups'] );
1475 if ( is_array( $firstGroup ) ||
is_object( $firstGroup ) ) {
1476 $this->mGroupMemberships
= [];
1477 foreach ( $data['user_groups'] as $row ) {
1478 $ugm = UserGroupMembership
::newFromRow( (object)$row );
1479 $this->mGroupMemberships
[$ugm->getGroup()] = $ugm;
1484 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1485 $this->loadOptions( $data['user_properties'] );
1491 * Load the data for this user object from another user object.
1495 protected function loadFromUserObject( $user ) {
1497 foreach ( self
::$mCacheVars as $var ) {
1498 $this->$var = $user->$var;
1503 * Load the groups from the database if they aren't already loaded.
1505 private function loadGroups() {
1506 if ( is_null( $this->mGroupMemberships
) ) {
1507 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1508 ?
wfGetDB( DB_MASTER
)
1509 : wfGetDB( DB_REPLICA
);
1510 $this->mGroupMemberships
= UserGroupMembership
::getMembershipsForUser(
1516 * Add the user to the group if he/she meets given criteria.
1518 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1519 * possible to remove manually via Special:UserRights. In such case it
1520 * will not be re-added automatically. The user will also not lose the
1521 * group if they no longer meet the criteria.
1523 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1525 * @return array Array of groups the user has been promoted to.
1527 * @see $wgAutopromoteOnce
1529 public function addAutopromoteOnceGroups( $event ) {
1530 global $wgAutopromoteOnceLogInRC;
1532 if ( wfReadOnly() ||
!$this->getId() ) {
1536 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1537 if ( $toPromote === [] ) {
1541 if ( !$this->checkAndSetTouched() ) {
1542 return []; // raced out (bug T48834)
1545 $oldGroups = $this->getGroups(); // previous groups
1546 $oldUGMs = $this->getGroupMemberships();
1547 foreach ( $toPromote as $group ) {
1548 $this->addGroup( $group );
1550 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1551 $newUGMs = $this->getGroupMemberships();
1553 // update groups in external authentication database
1554 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );
1556 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1557 $logEntry->setPerformer( $this );
1558 $logEntry->setTarget( $this->getUserPage() );
1559 $logEntry->setParameters( [
1560 '4::oldgroups' => $oldGroups,
1561 '5::newgroups' => $newGroups,
1563 $logid = $logEntry->insert();
1564 if ( $wgAutopromoteOnceLogInRC ) {
1565 $logEntry->publish( $logid );
1572 * Builds update conditions. Additional conditions may be added to $conditions to
1573 * protected against race conditions using a compare-and-set (CAS) mechanism
1574 * based on comparing $this->mTouched with the user_touched field.
1576 * @param IDatabase $db
1577 * @param array $conditions WHERE conditions for use with Database::update
1578 * @return array WHERE conditions for use with Database::update
1580 protected function makeUpdateConditions( IDatabase
$db, array $conditions ) {
1581 if ( $this->mTouched
) {
1582 // CAS check: only update if the row wasn't changed sicne it was loaded.
1583 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1590 * Bump user_touched if it didn't change since this object was loaded
1592 * On success, the mTouched field is updated.
1593 * The user serialization cache is always cleared.
1595 * @return bool Whether user_touched was actually updated
1598 protected function checkAndSetTouched() {
1601 if ( !$this->mId
) {
1602 return false; // anon
1605 // Get a new user_touched that is higher than the old one
1606 $newTouched = $this->newTouchedTimestamp();
1608 $dbw = wfGetDB( DB_MASTER
);
1609 $dbw->update( 'user',
1610 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1611 $this->makeUpdateConditions( $dbw, [
1612 'user_id' => $this->mId
,
1616 $success = ( $dbw->affectedRows() > 0 );
1619 $this->mTouched
= $newTouched;
1620 $this->clearSharedCache( 'changed' );
1622 // Clears on failure too since that is desired if the cache is stale
1623 $this->clearSharedCache( 'refresh' );
1630 * Clear various cached data stored in this object. The cache of the user table
1631 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1633 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1634 * given source. May be "name", "id", "actor", "defaults", "session", or false for no reload.
1636 public function clearInstanceCache( $reloadFrom = false ) {
1637 global $wgFullyInitialised;
1639 $this->mNewtalk
= -1;
1640 $this->mDatePreference
= null;
1641 $this->mBlockedby
= -1; # Unset
1642 $this->mHash
= false;
1643 $this->mEffectiveGroups
= null;
1644 $this->mImplicitGroups
= null;
1645 $this->mGroupMemberships
= null;
1646 $this->mOptions
= null;
1647 $this->mOptionsLoaded
= false;
1648 $this->mEditCount
= null;
1650 // Replacement of former `$this->mRights = null` line
1651 if ( $wgFullyInitialised && $this->mFrom
) {
1652 MediaWikiServices
::getInstance()->getPermissionManager()->invalidateUsersRightsCache(
1657 if ( $reloadFrom ) {
1658 $this->mLoadedItems
= [];
1659 $this->mFrom
= $reloadFrom;
1663 /** @var array|null */
1664 private static $defOpt = null;
1665 /** @var string|null */
1666 private static $defOptLang = null;
1669 * Reset the process cache of default user options. This is only necessary
1670 * if the wiki configuration has changed since defaults were calculated,
1671 * and as such should only be performed inside the testing suite that
1672 * regularly changes wiki configuration.
1674 public static function resetGetDefaultOptionsForTestsOnly() {
1675 Assert
::invariant( defined( 'MW_PHPUNIT_TEST' ), 'Unit tests only' );
1676 self
::$defOpt = null;
1677 self
::$defOptLang = null;
1681 * Combine the language default options with any site-specific options
1682 * and add the default language variants.
1684 * @return array Array of String options
1686 public static function getDefaultOptions() {
1687 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgDefaultSkin;
1689 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
1690 if ( self
::$defOpt !== null && self
::$defOptLang === $contLang->getCode() ) {
1691 // The content language does not change (and should not change) mid-request, but the
1692 // unit tests change it anyway, and expect this method to return values relevant to the
1693 // current content language.
1694 return self
::$defOpt;
1697 self
::$defOpt = $wgDefaultUserOptions;
1698 // Default language setting
1699 self
::$defOptLang = $contLang->getCode();
1700 self
::$defOpt['language'] = self
::$defOptLang;
1701 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1702 if ( $langCode === $contLang->getCode() ) {
1703 self
::$defOpt['variant'] = $langCode;
1705 self
::$defOpt["variant-$langCode"] = $langCode;
1709 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1710 // since extensions may change the set of searchable namespaces depending
1711 // on user groups/permissions.
1712 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1713 self
::$defOpt['searchNs' . $nsnum] = (bool)$val;
1715 self
::$defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1717 Hooks
::run( 'UserGetDefaultOptions', [ &self
::$defOpt ] );
1719 return self
::$defOpt;
1723 * Get a given default option value.
1725 * @param string $opt Name of option to retrieve
1726 * @return string Default option value
1728 public static function getDefaultOption( $opt ) {
1729 $defOpts = self
::getDefaultOptions();
1730 return $defOpts[$opt] ??
null;
1734 * Get blocking information
1736 * TODO: Move this into the BlockManager, along with block-related properties.
1738 * @param bool $fromReplica Whether to check the replica DB first.
1739 * To improve performance, non-critical checks are done against replica DBs.
1740 * Check when actually saving should be done against master.
1742 private function getBlockedStatus( $fromReplica = true ) {
1743 if ( $this->mBlockedby
!= -1 ) {
1747 wfDebug( __METHOD__
. ": checking...\n" );
1749 // Initialize data...
1750 // Otherwise something ends up stomping on $this->mBlockedby when
1751 // things get lazy-loaded later, causing false positive block hits
1752 // due to -1 !== 0. Probably session-related... Nothing should be
1753 // overwriting mBlockedby, surely?
1756 // TODO: Block checking shouldn't really be done from the User object. Block
1757 // checking can involve checking for IP blocks, cookie blocks, and/or XFF blocks,
1758 // which need more knowledge of the request context than the User should have.
1759 // Since we do currently check blocks from the User, we have to do the following
1761 // - Check if this is the user associated with the main request
1762 // - If so, pass the relevant request information to the block manager
1765 // The session user is set up towards the end of Setup.php. Until then,
1766 // assume it's a logged-out user.
1767 $sessionUser = RequestContext
::getMain()->getUser();
1768 $globalUserName = $sessionUser->isSafeToLoad()
1769 ?
$sessionUser->getName()
1770 : IP
::sanitizeIP( $sessionUser->getRequest()->getIP() );
1772 if ( $this->getName() === $globalUserName ) {
1773 // This is the global user, so we need to pass the request
1774 $request = $this->getRequest();
1777 // @phan-suppress-next-line PhanAccessMethodInternal It's the only allowed use
1778 $block = MediaWikiServices
::getInstance()->getBlockManager()->getUserBlock(
1785 $this->mBlock
= $block;
1786 $this->mBlockedby
= $block->getByName();
1787 $this->mBlockreason
= $block->getReason();
1788 $this->mHideName
= $block->getHideName();
1789 $this->mAllowUsertalk
= $block->isUsertalkEditAllowed();
1791 $this->mBlock
= null;
1792 $this->mBlockedby
= '';
1793 $this->mBlockreason
= '';
1794 $this->mHideName
= 0;
1795 $this->mAllowUsertalk
= false;
1798 // Avoid PHP 7.1 warning of passing $this by reference
1801 Hooks
::run( 'GetBlockedStatus', [ &$thisUser ] );
1805 * Whether the given IP is in a DNS blacklist.
1807 * @deprecated since 1.34 Use BlockManager::isDnsBlacklisted.
1808 * @param string $ip IP to check
1809 * @param bool $checkWhitelist Whether to check the whitelist first
1810 * @return bool True if blacklisted.
1812 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1813 return MediaWikiServices
::getInstance()->getBlockManager()
1814 ->isDnsBlacklisted( $ip, $checkWhitelist );
1818 * Whether the given IP is in a given DNS blacklist.
1820 * @deprecated since 1.34 Check via BlockManager::isDnsBlacklisted instead.
1821 * @param string $ip IP to check
1822 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1823 * @return bool True if blacklisted.
1825 public function inDnsBlacklist( $ip, $bases ) {
1826 wfDeprecated( __METHOD__
, '1.34' );
1829 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
1830 if ( IP
::isIPv4( $ip ) ) {
1831 // Reverse IP, T23255
1832 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1834 foreach ( (array)$bases as $base ) {
1836 // If we have an access key, use that too (ProjectHoneypot, etc.)
1838 if ( is_array( $base ) ) {
1839 if ( count( $base ) >= 2 ) {
1840 // Access key is 1, base URL is 0
1841 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1843 $host = "$ipReversed.{$base[0]}";
1845 $basename = $base[0];
1847 $host = "$ipReversed.$base";
1851 $ipList = gethostbynamel( $host );
1854 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
1859 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
1867 * Check if an IP address is in the local proxy list
1869 * @deprecated since 1.34 Use BlockManager::getUserBlock instead.
1873 public static function isLocallyBlockedProxy( $ip ) {
1874 wfDeprecated( __METHOD__
, '1.34' );
1876 global $wgProxyList;
1878 if ( !$wgProxyList ) {
1882 if ( !is_array( $wgProxyList ) ) {
1883 // Load values from the specified file
1884 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1887 $resultProxyList = [];
1888 $deprecatedIPEntries = [];
1890 // backward compatibility: move all ip addresses in keys to values
1891 foreach ( $wgProxyList as $key => $value ) {
1892 $keyIsIP = IP
::isIPAddress( $key );
1893 $valueIsIP = IP
::isIPAddress( $value );
1894 if ( $keyIsIP && !$valueIsIP ) {
1895 $deprecatedIPEntries[] = $key;
1896 $resultProxyList[] = $key;
1897 } elseif ( $keyIsIP && $valueIsIP ) {
1898 $deprecatedIPEntries[] = $key;
1899 $resultProxyList[] = $key;
1900 $resultProxyList[] = $value;
1902 $resultProxyList[] = $value;
1906 if ( $deprecatedIPEntries ) {
1908 'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
1909 implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
1912 $proxyListIPSet = new IPSet( $resultProxyList );
1913 return $proxyListIPSet->match( $ip );
1917 * Is this user subject to rate limiting?
1919 * @return bool True if rate limited
1921 public function isPingLimitable() {
1922 global $wgRateLimitsExcludedIPs;
1923 if ( IP
::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1924 // No other good way currently to disable rate limits
1925 // for specific IPs. :P
1926 // But this is a crappy hack and should die.
1929 return !$this->isAllowed( 'noratelimit' );
1933 * Primitive rate limits: enforce maximum actions per time period
1934 * to put a brake on flooding.
1936 * The method generates both a generic profiling point and a per action one
1937 * (suffix being "-$action".
1939 * @note When using a shared cache like memcached, IP-address
1940 * last-hit counters will be shared across wikis.
1942 * @param string $action Action to enforce; 'edit' if unspecified
1943 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1944 * @return bool True if a rate limiter was tripped
1946 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1947 // Avoid PHP 7.1 warning of passing $this by reference
1949 // Call the 'PingLimiter' hook
1951 if ( !Hooks
::run( 'PingLimiter', [ &$user, $action, &$result, $incrBy ] ) ) {
1955 global $wgRateLimits;
1956 if ( !isset( $wgRateLimits[$action] ) ) {
1960 $limits = array_merge(
1961 [ '&can-bypass' => true ],
1962 $wgRateLimits[$action]
1965 // Some groups shouldn't trigger the ping limiter, ever
1966 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
1971 $id = $this->getId();
1973 $isNewbie = $this->isNewbie();
1974 $cache = ObjectCache
::getLocalClusterInstance();
1978 if ( isset( $limits['anon'] ) ) {
1979 $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1981 } elseif ( isset( $limits['user'] ) ) {
1982 // limits for logged-in users
1983 $userLimit = $limits['user'];
1986 // limits for anons and for newbie logged-in users
1989 if ( isset( $limits['ip'] ) ) {
1990 $ip = $this->getRequest()->getIP();
1991 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1993 // subnet-based limits
1994 if ( isset( $limits['subnet'] ) ) {
1995 $ip = $this->getRequest()->getIP();
1996 $subnet = IP
::getSubnet( $ip );
1997 if ( $subnet !== false ) {
1998 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
2003 // Check for group-specific permissions
2004 // If more than one group applies, use the group with the highest limit ratio (max/period)
2005 foreach ( $this->getGroups() as $group ) {
2006 if ( isset( $limits[$group] ) ) {
2007 if ( $userLimit === false
2008 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
2010 $userLimit = $limits[$group];
2015 // limits for newbie logged-in users (override all the normal user limits)
2016 if ( $id !== 0 && $isNewbie && isset( $limits['newbie'] ) ) {
2017 $userLimit = $limits['newbie'];
2020 // Set the user limit key
2021 if ( $userLimit !== false ) {
2022 // phan is confused because &can-bypass's value is a bool, so it assumes
2023 // that $userLimit is also a bool here.
2024 // @phan-suppress-next-line PhanTypeInvalidExpressionArrayDestructuring
2025 list( $max, $period ) = $userLimit;
2026 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
2027 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
2030 // ip-based limits for all ping-limitable users
2031 if ( isset( $limits['ip-all'] ) ) {
2032 $ip = $this->getRequest()->getIP();
2033 // ignore if user limit is more permissive
2034 if ( $isNewbie ||
$userLimit === false
2035 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
2036 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
2040 // subnet-based limits for all ping-limitable users
2041 if ( isset( $limits['subnet-all'] ) ) {
2042 $ip = $this->getRequest()->getIP();
2043 $subnet = IP
::getSubnet( $ip );
2044 if ( $subnet !== false ) {
2045 // ignore if user limit is more permissive
2046 if ( $isNewbie ||
$userLimit === false
2047 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
2048 > $userLimit[0] / $userLimit[1] ) {
2049 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
2055 foreach ( $keys as $key => $limit ) {
2056 // phan is confused because &can-bypass's value is a bool, so it assumes
2057 // that $userLimit is also a bool here.
2058 // @phan-suppress-next-line PhanTypeInvalidExpressionArrayDestructuring
2059 list( $max, $period ) = $limit;
2060 $summary = "(limit $max in {$period}s)";
2061 $count = $cache->get( $key );
2063 if ( $count && $count >= $max ) {
2064 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
2065 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
2068 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
2069 if ( $incrBy > 0 ) {
2070 $cache->add( $key, 0, intval( $period ) ); // first ping
2073 if ( $incrBy > 0 ) {
2074 $cache->incrWithInit( $key, (int)$period, $incrBy, $incrBy );
2082 * Check if user is blocked
2084 * @deprecated since 1.34, use User::getBlock() or
2085 * PermissionManager::isBlockedFrom() or
2086 * PermissionManager::userCan() instead.
2088 * @param bool $fromReplica Whether to check the replica DB instead of
2089 * the master. Hacked from false due to horrible probs on site.
2090 * @return bool True if blocked, false otherwise
2092 public function isBlocked( $fromReplica = true ) {
2093 return $this->getBlock( $fromReplica ) instanceof AbstractBlock
&&
2094 $this->getBlock()->appliesToRight( 'edit' );
2098 * Get the block affecting the user, or null if the user is not blocked
2100 * @param bool $fromReplica Whether to check the replica DB instead of the master
2101 * @return AbstractBlock|null
2103 public function getBlock( $fromReplica = true ) {
2104 $this->getBlockedStatus( $fromReplica );
2105 return $this->mBlock
instanceof AbstractBlock ?
$this->mBlock
: null;
2109 * Check if user is blocked from editing a particular article
2111 * @param Title $title Title to check
2112 * @param bool $fromReplica Whether to check the replica DB instead of the master
2115 * @deprecated since 1.33,
2116 * use MediaWikiServices::getInstance()->getPermissionManager()->isBlockedFrom(..)
2119 public function isBlockedFrom( $title, $fromReplica = false ) {
2120 return MediaWikiServices
::getInstance()->getPermissionManager()
2121 ->isBlockedFrom( $this, $title, $fromReplica );
2125 * If user is blocked, return the name of the user who placed the block
2126 * @return string Name of blocker
2128 public function blockedBy() {
2129 $this->getBlockedStatus();
2130 return $this->mBlockedby
;
2134 * If user is blocked, return the specified reason for the block
2135 * @return string Blocking reason
2137 public function blockedFor() {
2138 $this->getBlockedStatus();
2139 return $this->mBlockreason
;
2143 * If user is blocked, return the ID for the block
2144 * @return int Block ID
2146 public function getBlockId() {
2147 $this->getBlockedStatus();
2148 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2152 * Check if user is blocked on all wikis.
2153 * Do not use for actual edit permission checks!
2154 * This is intended for quick UI checks.
2156 * @param string $ip IP address, uses current client if none given
2157 * @return bool True if blocked, false otherwise
2159 public function isBlockedGlobally( $ip = '' ) {
2160 return $this->getGlobalBlock( $ip ) instanceof AbstractBlock
;
2164 * Check if user is blocked on all wikis.
2165 * Do not use for actual edit permission checks!
2166 * This is intended for quick UI checks.
2168 * @param string $ip IP address, uses current client if none given
2169 * @return AbstractBlock|null Block object if blocked, null otherwise
2170 * @throws FatalError
2171 * @throws MWException
2173 public function getGlobalBlock( $ip = '' ) {
2174 if ( $this->mGlobalBlock
!== null ) {
2175 return $this->mGlobalBlock ?
: null;
2177 // User is already an IP?
2178 if ( IP
::isIPAddress( $this->getName() ) ) {
2179 $ip = $this->getName();
2181 $ip = $this->getRequest()->getIP();
2183 // Avoid PHP 7.1 warning of passing $this by reference
2187 Hooks
::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
2189 if ( $blocked && $block === null ) {
2190 // back-compat: UserIsBlockedGlobally didn't have $block param first
2191 $block = new SystemBlock( [
2193 'systemBlock' => 'global-block'
2197 $this->mGlobalBlock
= $blocked ?
$block : false;
2198 return $this->mGlobalBlock ?
: null;
2202 * Check if user account is locked
2204 * @return bool True if locked, false otherwise
2206 public function isLocked() {
2207 if ( $this->mLocked
!== null ) {
2208 return $this->mLocked
;
2211 $this->mLocked
= false;
2212 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2213 return $this->mLocked
;
2217 * Check if user account is hidden
2219 * @return bool True if hidden, false otherwise
2221 public function isHidden() {
2222 if ( $this->mHideName
!== null ) {
2223 return (bool)$this->mHideName
;
2225 $this->getBlockedStatus();
2226 if ( !$this->mHideName
) {
2228 $this->mHideName
= false;
2229 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2231 return (bool)$this->mHideName
;
2235 * Get the user's ID.
2236 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2238 public function getId() {
2239 if ( $this->mId
=== null && $this->mName
!== null && self
::isIP( $this->mName
) ) {
2240 // Special case, we know the user is anonymous
2244 if ( !$this->isItemLoaded( 'id' ) ) {
2245 // Don't load if this was initialized from an ID
2249 return (int)$this->mId
;
2253 * Set the user and reload all fields according to a given ID
2254 * @param int $v User ID to reload
2256 public function setId( $v ) {
2258 $this->clearInstanceCache( 'id' );
2262 * Get the user name, or the IP of an anonymous user
2263 * @return string User's name or IP address
2265 public function getName() {
2266 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2267 // Special case optimisation
2268 return $this->mName
;
2272 if ( $this->mName
=== false ) {
2274 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2277 return $this->mName
;
2281 * Set the user name.
2283 * This does not reload fields from the database according to the given
2284 * name. Rather, it is used to create a temporary "nonexistent user" for
2285 * later addition to the database. It can also be used to set the IP
2286 * address for an anonymous user to something other than the current
2289 * @note User::newFromName() has roughly the same function, when the named user
2291 * @param string $str New user name to set
2293 public function setName( $str ) {
2295 $this->mName
= $str;
2299 * Get the user's actor ID.
2301 * @param IDatabase|null $dbw Assign a new actor ID, using this DB handle, if none exists
2302 * @return int The actor's ID, or 0 if no actor ID exists and $dbw was null
2304 public function getActorId( IDatabase
$dbw = null ) {
2305 global $wgActorTableSchemaMigrationStage;
2307 // Technically we should always return 0 without SCHEMA_COMPAT_READ_NEW,
2308 // but it does little harm and might be needed for write callers loading a User.
2309 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) ) {
2313 if ( !$this->isItemLoaded( 'actor' ) ) {
2317 // Currently $this->mActorId might be null if $this was loaded from a
2318 // cache entry that was written when $wgActorTableSchemaMigrationStage
2319 // was SCHEMA_COMPAT_OLD. Once that is no longer a possibility (i.e. when
2320 // User::VERSION is incremented after $wgActorTableSchemaMigrationStage
2321 // has been removed), that condition may be removed.
2322 if ( $this->mActorId
=== null ||
!$this->mActorId
&& $dbw ) {
2324 'actor_user' => $this->getId() ?
: null,
2325 'actor_name' => (string)$this->getName(),
2328 if ( $q['actor_user'] === null && self
::isUsableName( $q['actor_name'] ) ) {
2329 throw new CannotCreateActorException(
2330 'Cannot create an actor for a usable name that is not an existing user'
2333 if ( $q['actor_name'] === '' ) {
2334 throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
2336 $dbw->insert( 'actor', $q, __METHOD__
, [ 'IGNORE' ] );
2337 if ( $dbw->affectedRows() ) {
2338 $this->mActorId
= (int)$dbw->insertId();
2341 // Use LOCK IN SHARE MODE to bypass any MySQL REPEATABLE-READ snapshot.
2342 $this->mActorId
= (int)$dbw->selectField(
2347 [ 'LOCK IN SHARE MODE' ]
2349 if ( !$this->mActorId
) {
2350 throw new CannotCreateActorException(
2351 "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
2355 $this->invalidateCache();
2357 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2358 $db = wfGetDB( $index );
2359 $this->mActorId
= (int)$db->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2361 $this->setItemLoaded( 'actor' );
2364 return (int)$this->mActorId
;
2368 * Get the user's name escaped by underscores.
2369 * @return string Username escaped by underscores.
2371 public function getTitleKey() {
2372 return str_replace( ' ', '_', $this->getName() );
2376 * Check if the user has new messages.
2377 * @return bool True if the user has new messages
2379 public function getNewtalk() {
2382 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2383 if ( $this->mNewtalk
=== -1 ) {
2384 $this->mNewtalk
= false; # reset talk page status
2386 // Check memcached separately for anons, who have no
2387 // entire User object stored in there.
2388 if ( !$this->mId
) {
2389 global $wgDisableAnonTalk;
2390 if ( $wgDisableAnonTalk ) {
2391 // Anon newtalk disabled by configuration.
2392 $this->mNewtalk
= false;
2394 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2397 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2401 return (bool)$this->mNewtalk
;
2405 * Return the data needed to construct links for new talk page message
2406 * alerts. If there are new messages, this will return an associative array
2407 * with the following data:
2408 * wiki: The database name of the wiki
2409 * link: Root-relative link to the user's talk page
2410 * rev: The last talk page revision that the user has seen or null. This
2411 * is useful for building diff links.
2412 * If there are no new messages, it returns an empty array.
2413 * @note This function was designed to accomodate multiple talk pages, but
2414 * currently only returns a single link and revision.
2417 public function getNewMessageLinks() {
2418 // Avoid PHP 7.1 warning of passing $this by reference
2421 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
2425 if ( !$this->getNewtalk() ) {
2428 $utp = $this->getTalkPage();
2429 $dbr = wfGetDB( DB_REPLICA
);
2430 // Get the "last viewed rev" timestamp from the oldest message notification
2431 $timestamp = $dbr->selectField( 'user_newtalk',
2432 'MIN(user_last_timestamp)',
2433 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2435 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2438 'wiki' => WikiMap
::getWikiIdFromDbDomain( WikiMap
::getCurrentWikiDbDomain() ),
2439 'link' => $utp->getLocalURL(),
2446 * Get the revision ID for the last talk page revision viewed by the talk
2448 * @return int|null Revision ID or null
2450 public function getNewMessageRevisionId() {
2451 $newMessageRevisionId = null;
2452 $newMessageLinks = $this->getNewMessageLinks();
2454 // Note: getNewMessageLinks() never returns more than a single link
2455 // and it is always for the same wiki, but we double-check here in
2456 // case that changes some time in the future.
2457 if ( $newMessageLinks && count( $newMessageLinks ) === 1
2458 && WikiMap
::isCurrentWikiId( $newMessageLinks[0]['wiki'] )
2459 && $newMessageLinks[0]['rev']
2461 /** @var Revision $newMessageRevision */
2462 $newMessageRevision = $newMessageLinks[0]['rev'];
2463 $newMessageRevisionId = $newMessageRevision->getId();
2466 return $newMessageRevisionId;
2470 * Internal uncached check for new messages
2473 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2474 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2475 * @return bool True if the user has new messages
2477 protected function checkNewtalk( $field, $id ) {
2478 $dbr = wfGetDB( DB_REPLICA
);
2480 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2482 return $ok !== false;
2486 * Add or update the new messages flag
2487 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2488 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2489 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2490 * @return bool True if successful, false otherwise
2492 protected function updateNewtalk( $field, $id, $curRev = null ) {
2493 // Get timestamp of the talk page revision prior to the current one
2494 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2495 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2496 // Mark the user as having new messages since this revision
2497 $dbw = wfGetDB( DB_MASTER
);
2498 $dbw->insert( 'user_newtalk',
2499 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2502 if ( $dbw->affectedRows() ) {
2503 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2507 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2512 * Clear the new messages flag for the given user
2513 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2514 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2515 * @return bool True if successful, false otherwise
2517 protected function deleteNewtalk( $field, $id ) {
2518 $dbw = wfGetDB( DB_MASTER
);
2519 $dbw->delete( 'user_newtalk',
2522 if ( $dbw->affectedRows() ) {
2523 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2527 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2532 * Update the 'You have new messages!' status.
2533 * @param bool $val Whether the user has new messages
2534 * @param Revision|null $curRev New, as yet unseen revision of the user talk
2535 * page. Ignored if null or !$val.
2537 public function setNewtalk( $val, $curRev = null ) {
2538 if ( wfReadOnly() ) {
2543 $this->mNewtalk
= $val;
2545 if ( $this->isAnon() ) {
2547 $id = $this->getName();
2550 $id = $this->getId();
2554 $changed = $this->updateNewtalk( $field, $id, $curRev );
2556 $changed = $this->deleteNewtalk( $field, $id );
2560 $this->invalidateCache();
2565 * Generate a current or new-future timestamp to be stored in the
2566 * user_touched field when we update things.
2568 * @return string Timestamp in TS_MW format
2570 private function newTouchedTimestamp() {
2572 if ( $this->mTouched
) {
2573 $time = max( $time, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2576 return wfTimestamp( TS_MW
, $time );
2580 * Clear user data from memcached
2582 * Use after applying updates to the database; caller's
2583 * responsibility to update user_touched if appropriate.
2585 * Called implicitly from invalidateCache() and saveSettings().
2587 * @param string $mode Use 'refresh' to clear now or 'changed' to clear before DB commit
2589 public function clearSharedCache( $mode = 'refresh' ) {
2590 if ( !$this->getId() ) {
2594 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2595 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2596 $key = $this->getCacheKey( $cache );
2598 if ( $mode === 'refresh' ) {
2599 $cache->delete( $key, 1 ); // low tombstone/"hold-off" TTL
2601 $lb->getConnectionRef( DB_MASTER
)->onTransactionPreCommitOrIdle(
2602 function () use ( $cache, $key ) {
2603 $cache->delete( $key );
2611 * Immediately touch the user data cache for this account
2613 * Calls touch() and removes account data from memcached
2615 public function invalidateCache() {
2617 $this->clearSharedCache( 'changed' );
2621 * Update the "touched" timestamp for the user
2623 * This is useful on various login/logout events when making sure that
2624 * a browser or proxy that has multiple tenants does not suffer cache
2625 * pollution where the new user sees the old users content. The value
2626 * of getTouched() is checked when determining 304 vs 200 responses.
2627 * Unlike invalidateCache(), this preserves the User object cache and
2628 * avoids database writes.
2632 public function touch() {
2633 $id = $this->getId();
2635 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2636 $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
2637 $cache->touchCheckKey( $key );
2638 $this->mQuickTouched
= null;
2643 * Validate the cache for this account.
2644 * @param string $timestamp A timestamp in TS_MW format
2647 public function validateCache( $timestamp ) {
2648 return ( $timestamp >= $this->getTouched() );
2652 * Get the user touched timestamp
2654 * Use this value only to validate caches via inequalities
2655 * such as in the case of HTTP If-Modified-Since response logic
2657 * @return string TS_MW Timestamp
2659 public function getTouched() {
2663 if ( $this->mQuickTouched
=== null ) {
2664 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2665 $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId
);
2667 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2670 return max( $this->mTouched
, $this->mQuickTouched
);
2673 return $this->mTouched
;
2677 * Get the user_touched timestamp field (time of last DB updates)
2678 * @return string TS_MW Timestamp
2681 public function getDBTouched() {
2684 return $this->mTouched
;
2688 * Set the password and reset the random token.
2689 * Calls through to authentication plugin if necessary;
2690 * will have no effect if the auth plugin refuses to
2691 * pass the change through or if the legal password
2694 * As a special case, setting the password to null
2695 * wipes it, so the account cannot be logged in until
2696 * a new password is set, for instance via e-mail.
2698 * @deprecated since 1.27, use AuthManager instead
2699 * @param string $str New password to set
2700 * @throws PasswordError On failure
2703 public function setPassword( $str ) {
2704 wfDeprecated( __METHOD__
, '1.27' );
2705 return $this->setPasswordInternal( $str );
2709 * Set the password and reset the random token unconditionally.
2711 * @deprecated since 1.27, use AuthManager instead
2712 * @param string|null $str New password to set or null to set an invalid
2713 * password hash meaning that the user will not be able to log in
2714 * through the web interface.
2716 public function setInternalPassword( $str ) {
2717 wfDeprecated( __METHOD__
, '1.27' );
2718 $this->setPasswordInternal( $str );
2722 * Actually set the password and such
2723 * @since 1.27 cannot set a password for a user not in the database
2724 * @param string|null $str New password to set or null to set an invalid
2725 * password hash meaning that the user will not be able to log in
2726 * through the web interface.
2727 * @return bool Success
2729 private function setPasswordInternal( $str ) {
2730 $manager = AuthManager
::singleton();
2732 // If the user doesn't exist yet, fail
2733 if ( !$manager->userExists( $this->getName() ) ) {
2734 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2737 $status = $this->changeAuthenticationData( [
2738 'username' => $this->getName(),
2742 if ( !$status->isGood() ) {
2743 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2744 ->info( __METHOD__
. ': Password change rejected: '
2745 . $status->getWikiText( null, null, 'en' ) );
2749 $this->setOption( 'watchlisttoken', false );
2750 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2756 * Changes credentials of the user.
2758 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2759 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2760 * e.g. when no provider handled the change.
2762 * @param array $data A set of authentication data in fieldname => value format. This is the
2763 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2767 public function changeAuthenticationData( array $data ) {
2768 $manager = AuthManager
::singleton();
2769 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2770 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2772 $status = Status
::newGood( 'ignored' );
2773 foreach ( $reqs as $req ) {
2774 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2776 if ( $status->getValue() === 'ignored' ) {
2777 $status->warning( 'authenticationdatachange-ignored' );
2780 if ( $status->isGood() ) {
2781 foreach ( $reqs as $req ) {
2782 $manager->changeAuthenticationData( $req );
2789 * Get the user's current token.
2790 * @param bool $forceCreation Force the generation of a new token if the
2791 * user doesn't have one (default=true for backwards compatibility).
2792 * @return string|null Token
2794 public function getToken( $forceCreation = true ) {
2795 global $wgAuthenticationTokenVersion;
2798 if ( !$this->mToken
&& $forceCreation ) {
2802 if ( !$this->mToken
) {
2803 // The user doesn't have a token, return null to indicate that.
2807 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
2808 // We return a random value here so existing token checks are very
2810 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2813 if ( $wgAuthenticationTokenVersion === null ) {
2814 // $wgAuthenticationTokenVersion not in use, so return the raw secret
2815 return $this->mToken
;
2818 // $wgAuthenticationTokenVersion in use, so hmac it.
2819 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
2821 // The raw hash can be overly long. Shorten it up.
2822 $len = max( 32, self
::TOKEN_LENGTH
);
2823 if ( strlen( $ret ) < $len ) {
2824 // Should never happen, even md5 is 128 bits
2825 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
2828 return substr( $ret, -$len );
2832 * Set the random token (used for persistent authentication)
2833 * Called from loadDefaults() among other places.
2835 * @param string|bool $token If specified, set the token to this value
2837 public function setToken( $token = false ) {
2839 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
2840 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
2841 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
2842 } elseif ( !$token ) {
2843 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2845 $this->mToken
= $token;
2850 * Set the password for a password reminder or new account email
2852 * @deprecated Removed in 1.27. Use PasswordReset instead.
2853 * @param string $str New password to set or null to set an invalid
2854 * password hash meaning that the user will not be able to use it
2855 * @param bool $throttle If true, reset the throttle timestamp to the present
2857 public function setNewpassword( $str, $throttle = true ) {
2858 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2862 * Get the user's e-mail address
2863 * @return string User's email address
2865 public function getEmail() {
2867 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
2868 return $this->mEmail
;
2872 * Get the timestamp of the user's e-mail authentication
2873 * @return string TS_MW timestamp
2875 public function getEmailAuthenticationTimestamp() {
2877 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
2878 return $this->mEmailAuthenticated
;
2882 * Set the user's e-mail address
2883 * @param string $str New e-mail address
2885 public function setEmail( $str ) {
2887 if ( $str == $this->mEmail
) {
2890 $this->invalidateEmail();
2891 $this->mEmail
= $str;
2892 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
2896 * Set the user's e-mail address and a confirmation mail if needed.
2899 * @param string $str New e-mail address
2902 public function setEmailWithConfirmation( $str ) {
2903 global $wgEnableEmail, $wgEmailAuthentication;
2905 if ( !$wgEnableEmail ) {
2906 return Status
::newFatal( 'emaildisabled' );
2909 $oldaddr = $this->getEmail();
2910 if ( $str === $oldaddr ) {
2911 return Status
::newGood( true );
2914 $type = $oldaddr != '' ?
'changed' : 'set';
2915 $notificationResult = null;
2917 if ( $wgEmailAuthentication && $type === 'changed' ) {
2918 // Send the user an email notifying the user of the change in registered
2919 // email address on their previous email address
2920 $change = $str != '' ?
'changed' : 'removed';
2921 $notificationResult = $this->sendMail(
2922 wfMessage( 'notificationemail_subject_' . $change )->text(),
2923 wfMessage( 'notificationemail_body_' . $change,
2924 $this->getRequest()->getIP(),
2930 $this->setEmail( $str );
2932 if ( $str !== '' && $wgEmailAuthentication ) {
2933 // Send a confirmation request to the new address if needed
2934 $result = $this->sendConfirmationMail( $type );
2936 if ( $notificationResult !== null ) {
2937 $result->merge( $notificationResult );
2940 if ( $result->isGood() ) {
2941 // Say to the caller that a confirmation and notification mail has been sent
2942 $result->value
= 'eauth';
2945 $result = Status
::newGood( true );
2952 * Get the user's real name
2953 * @return string User's real name
2955 public function getRealName() {
2956 if ( !$this->isItemLoaded( 'realname' ) ) {
2960 return $this->mRealName
;
2964 * Set the user's real name
2965 * @param string $str New real name
2967 public function setRealName( $str ) {
2969 $this->mRealName
= $str;
2973 * Get the user's current setting for a given option.
2975 * @param string $oname The option to check
2976 * @param string|array|null $defaultOverride A default value returned if the option does not exist
2977 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2978 * @return string|array|int|null User's current value for the option
2979 * @see getBoolOption()
2980 * @see getIntOption()
2982 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2983 global $wgHiddenPrefs;
2984 $this->loadOptions();
2986 # We want 'disabled' preferences to always behave as the default value for
2987 # users, even if they have set the option explicitly in their settings (ie they
2988 # set it, and then it was disabled removing their ability to change it). But
2989 # we don't want to erase the preferences in the database in case the preference
2990 # is re-enabled again. So don't touch $mOptions, just override the returned value
2991 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2992 return self
::getDefaultOption( $oname );
2995 if ( array_key_exists( $oname, $this->mOptions
) ) {
2996 return $this->mOptions
[$oname];
2999 return $defaultOverride;
3003 * Get all user's options
3005 * @param int $flags Bitwise combination of:
3006 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
3007 * to the default value. (Since 1.25)
3010 public function getOptions( $flags = 0 ) {
3011 global $wgHiddenPrefs;
3012 $this->loadOptions();
3013 $options = $this->mOptions
;
3015 # We want 'disabled' preferences to always behave as the default value for
3016 # users, even if they have set the option explicitly in their settings (ie they
3017 # set it, and then it was disabled removing their ability to change it). But
3018 # we don't want to erase the preferences in the database in case the preference
3019 # is re-enabled again. So don't touch $mOptions, just override the returned value
3020 foreach ( $wgHiddenPrefs as $pref ) {
3021 $default = self
::getDefaultOption( $pref );
3022 if ( $default !== null ) {
3023 $options[$pref] = $default;
3027 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
3028 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
3035 * Get the user's current setting for a given option, as a boolean value.
3037 * @param string $oname The option to check
3038 * @return bool User's current value for the option
3041 public function getBoolOption( $oname ) {
3042 return (bool)$this->getOption( $oname );
3046 * Get the user's current setting for a given option, as an integer value.
3048 * @param string $oname The option to check
3049 * @param int $defaultOverride A default value returned if the option does not exist
3050 * @return int User's current value for the option
3053 public function getIntOption( $oname, $defaultOverride = 0 ) {
3054 $val = $this->getOption( $oname );
3056 $val = $defaultOverride;
3058 return intval( $val );
3062 * Set the given option for a user.
3064 * You need to call saveSettings() to actually write to the database.
3066 * @param string $oname The option to set
3067 * @param mixed $val New value to set
3069 public function setOption( $oname, $val ) {
3070 $this->loadOptions();
3072 // Explicitly NULL values should refer to defaults
3073 if ( is_null( $val ) ) {
3074 $val = self
::getDefaultOption( $oname );
3077 $this->mOptions
[$oname] = $val;
3081 * Get a token stored in the preferences (like the watchlist one),
3082 * resetting it if it's empty (and saving changes).
3084 * @param string $oname The option name to retrieve the token from
3085 * @return string|bool User's current value for the option, or false if this option is disabled.
3086 * @see resetTokenFromOption()
3088 * @deprecated since 1.26 Applications should use the OAuth extension
3090 public function getTokenFromOption( $oname ) {
3091 global $wgHiddenPrefs;
3093 $id = $this->getId();
3094 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
3098 $token = $this->getOption( $oname );
3100 // Default to a value based on the user token to avoid space
3101 // wasted on storing tokens for all users. When this option
3102 // is set manually by the user, only then is it stored.
3103 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
3110 * Reset a token stored in the preferences (like the watchlist one).
3111 * *Does not* save user's preferences (similarly to setOption()).
3113 * @param string $oname The option name to reset the token in
3114 * @return string|bool New token value, or false if this option is disabled.
3115 * @see getTokenFromOption()
3118 public function resetTokenFromOption( $oname ) {
3119 global $wgHiddenPrefs;
3120 if ( in_array( $oname, $wgHiddenPrefs ) ) {
3124 $token = MWCryptRand
::generateHex( 40 );
3125 $this->setOption( $oname, $token );
3130 * Return a list of the types of user options currently returned by
3131 * User::getOptionKinds().
3133 * Currently, the option kinds are:
3134 * - 'registered' - preferences which are registered in core MediaWiki or
3135 * by extensions using the UserGetDefaultOptions hook.
3136 * - 'registered-multiselect' - as above, using the 'multiselect' type.
3137 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
3138 * - 'userjs' - preferences with names starting with 'userjs-', intended to
3139 * be used by user scripts.
3140 * - 'special' - "preferences" that are not accessible via User::getOptions
3141 * or User::setOptions.
3142 * - 'unused' - preferences about which MediaWiki doesn't know anything.
3143 * These are usually legacy options, removed in newer versions.
3145 * The API (and possibly others) use this function to determine the possible
3146 * option types for validation purposes, so make sure to update this when a
3147 * new option kind is added.
3149 * @see User::getOptionKinds
3150 * @return array Option kinds
3152 public static function listOptionKinds() {
3155 'registered-multiselect',
3156 'registered-checkmatrix',
3164 * Return an associative array mapping preferences keys to the kind of a preference they're
3165 * used for. Different kinds are handled differently when setting or reading preferences.
3167 * See User::listOptionKinds for the list of valid option types that can be provided.
3169 * @see User::listOptionKinds
3170 * @param IContextSource $context
3171 * @param array|null $options Assoc. array with options keys to check as keys.
3172 * Defaults to $this->mOptions.
3173 * @return array The key => kind mapping data
3175 public function getOptionKinds( IContextSource
$context, $options = null ) {
3176 $this->loadOptions();
3177 if ( $options === null ) {
3178 $options = $this->mOptions
;
3181 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
3182 $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
3185 // Pull out the "special" options, so they don't get converted as
3186 // multiselect or checkmatrix.
3187 $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
3188 foreach ( $specialOptions as $name => $value ) {
3189 unset( $prefs[$name] );
3192 // Multiselect and checkmatrix options are stored in the database with
3193 // one key per option, each having a boolean value. Extract those keys.
3194 $multiselectOptions = [];
3195 foreach ( $prefs as $name => $info ) {
3196 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3197 ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField
::class ) ) {
3198 $opts = HTMLFormField
::flattenOptions( $info['options'] );
3199 $prefix = $info['prefix'] ??
$name;
3201 foreach ( $opts as $value ) {
3202 $multiselectOptions["$prefix$value"] = true;
3205 unset( $prefs[$name] );
3208 $checkmatrixOptions = [];
3209 foreach ( $prefs as $name => $info ) {
3210 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3211 ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix
::class ) ) {
3212 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3213 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3214 $prefix = $info['prefix'] ??
$name;
3216 foreach ( $columns as $column ) {
3217 foreach ( $rows as $row ) {
3218 $checkmatrixOptions["$prefix$column-$row"] = true;
3222 unset( $prefs[$name] );
3226 // $value is ignored
3227 foreach ( $options as $key => $value ) {
3228 if ( isset( $prefs[$key] ) ) {
3229 $mapping[$key] = 'registered';
3230 } elseif ( isset( $multiselectOptions[$key] ) ) {
3231 $mapping[$key] = 'registered-multiselect';
3232 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3233 $mapping[$key] = 'registered-checkmatrix';
3234 } elseif ( isset( $specialOptions[$key] ) ) {
3235 $mapping[$key] = 'special';
3236 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3237 $mapping[$key] = 'userjs';
3239 $mapping[$key] = 'unused';
3247 * Reset certain (or all) options to the site defaults
3249 * The optional parameter determines which kinds of preferences will be reset.
3250 * Supported values are everything that can be reported by getOptionKinds()
3251 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3253 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3254 * [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ]
3255 * for backwards-compatibility.
3256 * @param IContextSource|null $context Context source used when $resetKinds
3257 * does not contain 'all', passed to getOptionKinds().
3258 * Defaults to RequestContext::getMain() when null.
3260 public function resetOptions(
3261 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3262 IContextSource
$context = null
3265 $defaultOptions = self
::getDefaultOptions();
3267 if ( !is_array( $resetKinds ) ) {
3268 $resetKinds = [ $resetKinds ];
3271 if ( in_array( 'all', $resetKinds ) ) {
3272 $newOptions = $defaultOptions;
3274 if ( $context === null ) {
3275 $context = RequestContext
::getMain();
3278 $optionKinds = $this->getOptionKinds( $context );
3279 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3282 // Use default values for the options that should be deleted, and
3283 // copy old values for the ones that shouldn't.
3284 foreach ( $this->mOptions
as $key => $value ) {
3285 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3286 if ( array_key_exists( $key, $defaultOptions ) ) {
3287 $newOptions[$key] = $defaultOptions[$key];
3290 $newOptions[$key] = $value;
3295 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3297 $this->mOptions
= $newOptions;
3298 $this->mOptionsLoaded
= true;
3302 * Get the user's preferred date format.
3303 * @return string User's preferred date format
3305 public function getDatePreference() {
3306 // Important migration for old data rows
3307 if ( is_null( $this->mDatePreference
) ) {
3309 $value = $this->getOption( 'date' );
3310 $map = $wgLang->getDatePreferenceMigrationMap();
3311 if ( isset( $map[$value] ) ) {
3312 $value = $map[$value];
3314 $this->mDatePreference
= $value;
3316 return $this->mDatePreference
;
3320 * Determine based on the wiki configuration and the user's options,
3321 * whether this user must be over HTTPS no matter what.
3325 public function requiresHTTPS() {
3326 global $wgSecureLogin;
3327 if ( !$wgSecureLogin ) {
3331 $https = $this->getBoolOption( 'prefershttps' );
3332 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3334 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3341 * Get the user preferred stub threshold
3345 public function getStubThreshold() {
3346 global $wgMaxArticleSize; # Maximum article size, in Kb
3347 $threshold = $this->getIntOption( 'stubthreshold' );
3348 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3349 // If they have set an impossible value, disable the preference
3350 // so we can use the parser cache again.
3357 * Get the permissions this user has.
3358 * @return string[] permission names
3360 * @deprecated since 1.34, use MediaWikiServices::getInstance()->getPermissionManager()
3361 * ->getUserPermissions(..) instead
3364 public function getRights() {
3365 return MediaWikiServices
::getInstance()->getPermissionManager()->getUserPermissions( $this );
3369 * Get the list of explicit group memberships this user has.
3370 * The implicit * and user groups are not included.
3372 * @return string[] Array of internal group names (sorted since 1.33)
3374 public function getGroups() {
3376 $this->loadGroups();
3377 return array_keys( $this->mGroupMemberships
);
3381 * Get the list of explicit group memberships this user has, stored as
3382 * UserGroupMembership objects. Implicit groups are not included.
3384 * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
3387 public function getGroupMemberships() {
3389 $this->loadGroups();
3390 return $this->mGroupMemberships
;
3394 * Get the list of implicit group memberships this user has.
3395 * This includes all explicit groups, plus 'user' if logged in,
3396 * '*' for all accounts, and autopromoted groups
3397 * @param bool $recache Whether to avoid the cache
3398 * @return array Array of String internal group names
3400 public function getEffectiveGroups( $recache = false ) {
3401 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3402 $this->mEffectiveGroups
= array_unique( array_merge(
3403 $this->getGroups(), // explicit groups
3404 $this->getAutomaticGroups( $recache ) // implicit groups
3406 // Avoid PHP 7.1 warning of passing $this by reference
3408 // Hook for additional groups
3409 Hooks
::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups
] );
3410 // Force reindexation of groups when a hook has unset one of them
3411 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3413 return $this->mEffectiveGroups
;
3417 * Get the list of implicit group memberships this user has.
3418 * This includes 'user' if logged in, '*' for all accounts,
3419 * and autopromoted groups
3420 * @param bool $recache Whether to avoid the cache
3421 * @return array Array of String internal group names
3423 public function getAutomaticGroups( $recache = false ) {
3424 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3425 $this->mImplicitGroups
= [ '*' ];
3426 if ( $this->getId() ) {
3427 $this->mImplicitGroups
[] = 'user';
3429 $this->mImplicitGroups
= array_unique( array_merge(
3430 $this->mImplicitGroups
,
3431 Autopromote
::getAutopromoteGroups( $this )
3435 // Assure data consistency with rights/groups,
3436 // as getEffectiveGroups() depends on this function
3437 $this->mEffectiveGroups
= null;
3440 return $this->mImplicitGroups
;
3444 * Returns the groups the user has belonged to.
3446 * The user may still belong to the returned groups. Compare with getGroups().
3448 * The function will not return groups the user had belonged to before MW 1.17
3450 * @return array Names of the groups the user has belonged to.
3452 public function getFormerGroups() {
3455 if ( is_null( $this->mFormerGroups
) ) {
3456 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3457 ?
wfGetDB( DB_MASTER
)
3458 : wfGetDB( DB_REPLICA
);
3459 $res = $db->select( 'user_former_groups',
3461 [ 'ufg_user' => $this->mId
],
3463 $this->mFormerGroups
= [];
3464 foreach ( $res as $row ) {
3465 $this->mFormerGroups
[] = $row->ufg_group
;
3469 return $this->mFormerGroups
;
3473 * Get the user's edit count.
3474 * @return int|null Null for anonymous users
3476 public function getEditCount() {
3477 if ( !$this->getId() ) {
3481 if ( $this->mEditCount
=== null ) {
3482 /* Populate the count, if it has not been populated yet */
3483 $dbr = wfGetDB( DB_REPLICA
);
3484 // check if the user_editcount field has been initialized
3485 $count = $dbr->selectField(
3486 'user', 'user_editcount',
3487 [ 'user_id' => $this->mId
],
3491 if ( $count === null ) {
3492 // it has not been initialized. do so.
3493 $count = $this->initEditCountInternal( $dbr );
3495 $this->mEditCount
= $count;
3497 return (int)$this->mEditCount
;
3501 * Add the user to the given group. This takes immediate effect.
3502 * If the user is already in the group, the expiry time will be updated to the new
3503 * expiry time. (If $expiry is omitted or null, the membership will be altered to
3506 * @param string $group Name of the group to add
3507 * @param string|null $expiry Optional expiry timestamp in any format acceptable to
3508 * wfTimestamp(), or null if the group assignment should not expire
3511 public function addGroup( $group, $expiry = null ) {
3513 $this->loadGroups();
3516 $expiry = wfTimestamp( TS_MW
, $expiry );
3519 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
3523 // create the new UserGroupMembership and put it in the DB
3524 $ugm = new UserGroupMembership( $this->mId
, $group, $expiry );
3525 if ( !$ugm->insert( true ) ) {
3529 $this->mGroupMemberships
[$group] = $ugm;
3531 // Refresh the groups caches, and clear the rights cache so it will be
3532 // refreshed on the next call to $this->getRights().
3533 $this->getEffectiveGroups( true );
3534 MediaWikiServices
::getInstance()->getPermissionManager()->invalidateUsersRightsCache( $this );
3535 $this->invalidateCache();
3541 * Remove the user from the given group.
3542 * This takes immediate effect.
3543 * @param string $group Name of the group to remove
3546 public function removeGroup( $group ) {
3549 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3553 $ugm = UserGroupMembership
::getMembership( $this->mId
, $group );
3554 // delete the membership entry
3555 if ( !$ugm ||
!$ugm->delete() ) {
3559 $this->loadGroups();
3560 unset( $this->mGroupMemberships
[$group] );
3562 // Refresh the groups caches, and clear the rights cache so it will be
3563 // refreshed on the next call to $this->getRights().
3564 $this->getEffectiveGroups( true );
3565 MediaWikiServices
::getInstance()->getPermissionManager()->invalidateUsersRightsCache( $this );
3566 $this->invalidateCache();
3572 * Alias of isLoggedIn() with a name that describes its actual functionality. UserIdentity has
3573 * only this new name and not the old isLoggedIn() variant.
3575 * @return bool True if user is registered on this wiki, i.e., has a user ID. False if user is
3576 * anonymous or has no local account (which can happen when importing). This is equivalent to
3577 * getId() != 0 and is provided for code readability.
3580 public function isRegistered() {
3581 return $this->getId() != 0;
3585 * Get whether the user is logged in
3588 public function isLoggedIn() {
3589 return $this->isRegistered();
3593 * Get whether the user is anonymous
3596 public function isAnon() {
3597 return !$this->isRegistered();
3601 * @return bool Whether this user is flagged as being a bot role account
3604 public function isBot() {
3605 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3610 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3616 * Check if user is allowed to access a feature / make an action
3618 * @deprecated since 1.34, use MediaWikiServices::getInstance()
3619 * ->getPermissionManager()->userHasAnyRights(...) instead
3621 * @param string $permissions,... Permissions to test
3622 * @return bool True if user is allowed to perform *any* of the given actions
3623 * @suppress PhanCommentParamOnEmptyParamList Cannot make variadic due to HHVM bug, T191668#5263929
3625 public function isAllowedAny() {
3626 return MediaWikiServices
::getInstance()
3627 ->getPermissionManager()
3628 ->userHasAnyRight( $this, ...func_get_args() );
3632 * @deprecated since 1.34, use MediaWikiServices::getInstance()
3633 * ->getPermissionManager()->userHasAllRights(...) instead
3634 * @param string $permissions,... Permissions to test
3635 * @return bool True if the user is allowed to perform *all* of the given actions
3636 * @suppress PhanCommentParamOnEmptyParamList Cannot make variadic due to HHVM bug, T191668#5263929
3638 public function isAllowedAll() {
3639 return MediaWikiServices
::getInstance()
3640 ->getPermissionManager()
3641 ->userHasAllRights( $this, ...func_get_args() );
3645 * Internal mechanics of testing a permission
3647 * @deprecated since 1.34, use MediaWikiServices::getInstance()
3648 * ->getPermissionManager()->userHasRight(...) instead
3650 * @param string $action
3654 public function isAllowed( $action = '' ) {
3655 return MediaWikiServices
::getInstance()->getPermissionManager()
3656 ->userHasRight( $this, $action );
3660 * Check whether to enable recent changes patrol features for this user
3661 * @return bool True or false
3663 public function useRCPatrol() {
3664 global $wgUseRCPatrol;
3665 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3669 * Check whether to enable new pages patrol features for this user
3670 * @return bool True or false
3672 public function useNPPatrol() {
3673 global $wgUseRCPatrol, $wgUseNPPatrol;
3675 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3676 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3681 * Check whether to enable new files patrol features for this user
3682 * @return bool True or false
3684 public function useFilePatrol() {
3685 global $wgUseRCPatrol, $wgUseFilePatrol;
3687 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3688 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3693 * Get the WebRequest object to use with this object
3695 * @return WebRequest
3697 public function getRequest() {
3698 if ( $this->mRequest
) {
3699 return $this->mRequest
;
3707 * Check the watched status of an article.
3708 * @since 1.22 $checkRights parameter added
3709 * @param Title $title Title of the article to look at
3710 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3711 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3714 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3715 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3716 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3723 * @since 1.22 $checkRights parameter added
3724 * @param Title $title Title of the article to look at
3725 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3726 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3728 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3729 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3730 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3732 [ $title->getSubjectPage(), $title->getTalkPage() ]
3735 $this->invalidateCache();
3739 * Stop watching an article.
3740 * @since 1.22 $checkRights parameter added
3741 * @param Title $title Title of the article to look at
3742 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3743 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3745 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3746 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3747 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3748 $store->removeWatch( $this, $title->getSubjectPage() );
3749 $store->removeWatch( $this, $title->getTalkPage() );
3751 $this->invalidateCache();
3755 * Clear the user's notification timestamp for the given title.
3756 * If e-notif e-mails are on, they will receive notification mails on
3757 * the next change of the page if it's watched etc.
3758 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3759 * @param Title &$title Title of the article to look at
3760 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3762 public function clearNotification( &$title, $oldid = 0 ) {
3763 global $wgUseEnotif, $wgShowUpdatedMarker;
3765 // Do nothing if the database is locked to writes
3766 if ( wfReadOnly() ) {
3770 // Do nothing if not allowed to edit the watchlist
3771 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3775 // If we're working on user's talk page, we should update the talk page message indicator
3776 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3777 // Avoid PHP 7.1 warning of passing $this by reference
3779 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
3783 // Try to update the DB post-send and only if needed...
3784 DeferredUpdates
::addCallableUpdate( function () use ( $title, $oldid ) {
3785 if ( !$this->getNewtalk() ) {
3786 return; // no notifications to clear
3789 // Delete the last notifications (they stack up)
3790 $this->setNewtalk( false );
3792 // If there is a new, unseen, revision, use its timestamp
3794 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
3797 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
3802 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3806 if ( $this->isAnon() ) {
3807 // Nothing else to do...
3811 // Only update the timestamp if the page is being watched.
3812 // The query to find out if it is watched is cached both in memcached and per-invocation,
3813 // and when it does have to be executed, it can be on a replica DB
3814 // If this is the user's newtalk page, we always update the timestamp
3816 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3820 MediaWikiServices
::getInstance()->getWatchedItemStore()
3821 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
3825 * Resets all of the given user's page-change notification timestamps.
3826 * If e-notif e-mails are on, they will receive notification mails on
3827 * the next change of any watched page.
3828 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3830 public function clearAllNotifications() {
3831 global $wgUseEnotif, $wgShowUpdatedMarker;
3832 // Do nothing if not allowed to edit the watchlist
3833 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
3837 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3838 $this->setNewtalk( false );
3842 $id = $this->getId();
3847 $watchedItemStore = MediaWikiServices
::getInstance()->getWatchedItemStore();
3848 $watchedItemStore->resetAllNotificationTimestampsForUser( $this );
3850 // We also need to clear here the "you have new message" notification for the own
3851 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
3855 * Compute experienced level based on edit count and registration date.
3857 * @return string 'newcomer', 'learner', or 'experienced'
3859 public function getExperienceLevel() {
3860 global $wgLearnerEdits,
3861 $wgExperiencedUserEdits,
3862 $wgLearnerMemberSince,
3863 $wgExperiencedUserMemberSince;
3865 if ( $this->isAnon() ) {
3869 $editCount = $this->getEditCount();
3870 $registration = $this->getRegistration();
3872 $learnerRegistration = wfTimestamp( TS_MW
, $now - $wgLearnerMemberSince * 86400 );
3873 $experiencedRegistration = wfTimestamp( TS_MW
, $now - $wgExperiencedUserMemberSince * 86400 );
3875 if ( $editCount < $wgLearnerEdits ||
3876 $registration > $learnerRegistration ) {
3880 if ( $editCount > $wgExperiencedUserEdits &&
3881 $registration <= $experiencedRegistration
3883 return 'experienced';
3890 * Persist this user's session (e.g. set cookies)
3892 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3894 * @param bool|null $secure Whether to force secure/insecure cookies or use default
3895 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3897 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3899 if ( $this->mId
== 0 ) {
3903 $session = $this->getRequest()->getSession();
3904 if ( $request && $session->getRequest() !== $request ) {
3905 $session = $session->sessionWithRequest( $request );
3907 $delay = $session->delaySave();
3909 if ( !$session->getUser()->equals( $this ) ) {
3910 if ( !$session->canSetUser() ) {
3911 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3912 ->warning( __METHOD__
.
3913 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
3917 $session->setUser( $this );
3920 $session->setRememberUser( $rememberMe );
3921 if ( $secure !== null ) {
3922 $session->setForceHTTPS( $secure );
3925 $session->persist();
3927 ScopedCallback
::consume( $delay );
3931 * Log this user out.
3933 public function logout() {
3934 // Avoid PHP 7.1 warning of passing $this by reference
3936 if ( Hooks
::run( 'UserLogout', [ &$user ] ) ) {
3942 * Clear the user's session, and reset the instance cache.
3945 public function doLogout() {
3946 $session = $this->getRequest()->getSession();
3947 if ( !$session->canSetUser() ) {
3948 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3949 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
3950 $error = 'immutable';
3951 } elseif ( !$session->getUser()->equals( $this ) ) {
3952 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3953 ->warning( __METHOD__
.
3954 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
3956 // But we still may as well make this user object anon
3957 $this->clearInstanceCache( 'defaults' );
3958 $error = 'wronguser';
3960 $this->clearInstanceCache( 'defaults' );
3961 $delay = $session->delaySave();
3962 $session->unpersist(); // Clear cookies (T127436)
3963 $session->setLoggedOutTimestamp( time() );
3964 $session->setUser( new User
);
3965 $session->set( 'wsUserID', 0 ); // Other code expects this
3966 $session->resetAllTokens();
3967 ScopedCallback
::consume( $delay );
3970 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
3971 'event' => 'logout',
3972 'successful' => $error === false,
3973 'status' => $error ?
: 'success',
3978 * Save this user's settings into the database.
3979 * @todo Only rarely do all these fields need to be set!
3981 public function saveSettings() {
3982 if ( wfReadOnly() ) {
3983 // @TODO: caller should deal with this instead!
3984 // This should really just be an exception.
3985 MWExceptionHandler
::logException( new DBExpectedError(
3987 "Could not update user with ID '{$this->mId}'; DB is read-only."
3993 if ( $this->mId
== 0 ) {
3997 // Get a new user_touched that is higher than the old one.
3998 // This will be used for a CAS check as a last-resort safety
3999 // check against race conditions and replica DB lag.
4000 $newTouched = $this->newTouchedTimestamp();
4002 $dbw = wfGetDB( DB_MASTER
);
4003 $dbw->doAtomicSection( __METHOD__
, function ( IDatabase
$dbw, $fname ) use ( $newTouched ) {
4004 global $wgActorTableSchemaMigrationStage;
4006 $dbw->update( 'user',
4008 'user_name' => $this->mName
,
4009 'user_real_name' => $this->mRealName
,
4010 'user_email' => $this->mEmail
,
4011 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4012 'user_touched' => $dbw->timestamp( $newTouched ),
4013 'user_token' => strval( $this->mToken
),
4014 'user_email_token' => $this->mEmailToken
,
4015 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
4016 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
4017 'user_id' => $this->mId
,
4021 if ( !$dbw->affectedRows() ) {
4022 // Maybe the problem was a missed cache update; clear it to be safe
4023 $this->clearSharedCache( 'refresh' );
4024 // User was changed in the meantime or loaded with stale data
4025 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
4026 LoggerFactory
::getInstance( 'preferences' )->warning(
4027 "CAS update failed on user_touched for user ID '{user_id}' ({db_flag} read)",
4028 [ 'user_id' => $this->mId
, 'db_flag' => $from ]
4030 throw new MWException( "CAS update failed on user_touched. " .
4031 "The version of the user to be saved is older than the current version."
4035 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4038 [ 'actor_name' => $this->mName
],
4039 [ 'actor_user' => $this->mId
],
4045 $this->mTouched
= $newTouched;
4046 $this->saveOptions();
4048 Hooks
::run( 'UserSaveSettings', [ $this ] );
4049 $this->clearSharedCache( 'changed' );
4050 $this->getUserPage()->purgeSquid();
4054 * If only this user's username is known, and it exists, return the user ID.
4056 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
4059 public function idForName( $flags = 0 ) {
4060 $s = trim( $this->getName() );
4065 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
4066 ?
wfGetDB( DB_MASTER
)
4067 : wfGetDB( DB_REPLICA
);
4069 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
4070 ?
[ 'LOCK IN SHARE MODE' ]
4073 $id = $db->selectField( 'user',
4074 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
4080 * Add a user to the database, return the user object
4082 * @param string $name Username to add
4083 * @param array $params Array of Strings Non-default parameters to save to
4084 * the database as user_* fields:
4085 * - email: The user's email address.
4086 * - email_authenticated: The email authentication timestamp.
4087 * - real_name: The user's real name.
4088 * - options: An associative array of non-default options.
4089 * - token: Random authentication token. Do not set.
4090 * - registration: Registration timestamp. Do not set.
4092 * @return User|null User object, or null if the username already exists.
4094 public static function createNew( $name, $params = [] ) {
4095 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
4096 if ( isset( $params[$field] ) ) {
4097 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
4098 unset( $params[$field] );
4104 $user->setToken(); // init token
4105 if ( isset( $params['options'] ) ) {
4106 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
4107 unset( $params['options'] );
4109 $dbw = wfGetDB( DB_MASTER
);
4111 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4114 'user_name' => $name,
4115 'user_password' => $noPass,
4116 'user_newpassword' => $noPass,
4117 'user_email' => $user->mEmail
,
4118 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
4119 'user_real_name' => $user->mRealName
,
4120 'user_token' => strval( $user->mToken
),
4121 'user_registration' => $dbw->timestamp( $user->mRegistration
),
4122 'user_editcount' => 0,
4123 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4125 foreach ( $params as $name => $value ) {
4126 $fields["user_$name"] = $value;
4129 return $dbw->doAtomicSection( __METHOD__
, function ( IDatabase
$dbw, $fname ) use ( $fields ) {
4130 $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
4131 if ( $dbw->affectedRows() ) {
4132 $newUser = self
::newFromId( $dbw->insertId() );
4133 $newUser->mName
= $fields['user_name'];
4134 $newUser->updateActorId( $dbw );
4135 // Load the user from master to avoid replica lag
4136 $newUser->load( self
::READ_LATEST
);
4145 * Add this existing user object to the database. If the user already
4146 * exists, a fatal status object is returned, and the user object is
4147 * initialised with the data from the database.
4149 * Previously, this function generated a DB error due to a key conflict
4150 * if the user already existed. Many extension callers use this function
4151 * in code along the lines of:
4153 * $user = User::newFromName( $name );
4154 * if ( !$user->isLoggedIn() ) {
4155 * $user->addToDatabase();
4157 * // do something with $user...
4159 * However, this was vulnerable to a race condition (T18020). By
4160 * initialising the user object if the user exists, we aim to support this
4161 * calling sequence as far as possible.
4163 * Note that if the user exists, this function will acquire a write lock,
4164 * so it is still advisable to make the call conditional on isLoggedIn(),
4165 * and to commit the transaction after calling.
4167 * @throws MWException
4170 public function addToDatabase() {
4172 if ( !$this->mToken
) {
4173 $this->setToken(); // init token
4176 if ( !is_string( $this->mName
) ) {
4177 throw new RuntimeException( "User name field is not set." );
4180 $this->mTouched
= $this->newTouchedTimestamp();
4182 $dbw = wfGetDB( DB_MASTER
);
4183 $status = $dbw->doAtomicSection( __METHOD__
, function ( IDatabase
$dbw, $fname ) {
4184 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4185 $dbw->insert( 'user',
4187 'user_name' => $this->mName
,
4188 'user_password' => $noPass,
4189 'user_newpassword' => $noPass,
4190 'user_email' => $this->mEmail
,
4191 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4192 'user_real_name' => $this->mRealName
,
4193 'user_token' => strval( $this->mToken
),
4194 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4195 'user_editcount' => 0,
4196 'user_touched' => $dbw->timestamp( $this->mTouched
),
4200 if ( !$dbw->affectedRows() ) {
4201 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4202 $this->mId
= $dbw->selectField(
4205 [ 'user_name' => $this->mName
],
4207 [ 'LOCK IN SHARE MODE' ]
4210 if ( $this->mId
&& $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4214 throw new MWException( $fname . ": hit a key conflict attempting " .
4215 "to insert user '{$this->mName}' row, but it was not present in select!" );
4217 return Status
::newFatal( 'userexists' );
4219 $this->mId
= $dbw->insertId();
4220 self
::$idCacheByName[$this->mName
] = $this->mId
;
4221 $this->updateActorId( $dbw );
4223 return Status
::newGood();
4225 if ( !$status->isGood() ) {
4229 // Clear instance cache other than user table data and actor, which is already accurate
4230 $this->clearInstanceCache();
4232 $this->saveOptions();
4233 return Status
::newGood();
4237 * Update the actor ID after an insert
4238 * @param IDatabase $dbw Writable database handle
4240 private function updateActorId( IDatabase
$dbw ) {
4241 global $wgActorTableSchemaMigrationStage;
4243 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4246 [ 'actor_user' => $this->mId
, 'actor_name' => $this->mName
],
4249 $this->mActorId
= (int)$dbw->insertId();
4254 * If this user is logged-in and blocked,
4255 * block any IP address they've successfully logged in from.
4256 * @return bool A block was spread
4258 public function spreadAnyEditBlock() {
4259 if ( $this->isLoggedIn() && $this->getBlock() ) {
4260 return $this->spreadBlock();
4267 * If this (non-anonymous) user is blocked,
4268 * block the IP address they've successfully logged in from.
4269 * @return bool A block was spread
4271 protected function spreadBlock() {
4272 wfDebug( __METHOD__
. "()\n" );
4274 if ( $this->mId
== 0 ) {
4278 $userblock = DatabaseBlock
::newFromTarget( $this->getName() );
4279 if ( !$userblock ) {
4283 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4287 * Get whether the user is explicitly blocked from account creation.
4288 * @return bool|AbstractBlock
4290 public function isBlockedFromCreateAccount() {
4291 $this->getBlockedStatus();
4292 if ( $this->mBlock
&& $this->mBlock
->appliesToRight( 'createaccount' ) ) {
4293 return $this->mBlock
;
4296 # T15611: if the IP address the user is trying to create an account from is
4297 # blocked with createaccount disabled, prevent new account creation there even
4298 # when the user is logged in
4299 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4300 $this->mBlockedFromCreateAccount
= DatabaseBlock
::newFromTarget(
4301 null, $this->getRequest()->getIP()
4304 return $this->mBlockedFromCreateAccount
instanceof AbstractBlock
4305 && $this->mBlockedFromCreateAccount
->appliesToRight( 'createaccount' )
4306 ?
$this->mBlockedFromCreateAccount
4311 * Get whether the user is blocked from using Special:Emailuser.
4314 public function isBlockedFromEmailuser() {
4315 $this->getBlockedStatus();
4316 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'sendemail' );
4320 * Get whether the user is blocked from using Special:Upload
4325 public function isBlockedFromUpload() {
4326 $this->getBlockedStatus();
4327 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'upload' );
4331 * Get whether the user is allowed to create an account.
4334 public function isAllowedToCreateAccount() {
4335 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4339 * Get this user's personal page title.
4341 * @return Title User's personal page title
4343 public function getUserPage() {
4344 return Title
::makeTitle( NS_USER
, $this->getName() );
4348 * Get this user's talk page title.
4350 * @return Title User's talk page title
4352 public function getTalkPage() {
4353 $title = $this->getUserPage();
4354 return $title->getTalkPage();
4358 * Determine whether the user is a newbie. Newbies are either
4359 * anonymous IPs, or the most recently created accounts.
4362 public function isNewbie() {
4363 return !$this->isAllowed( 'autoconfirmed' );
4367 * Check to see if the given clear-text password is one of the accepted passwords
4368 * @deprecated since 1.27, use AuthManager instead
4369 * @param string $password User password
4370 * @return bool True if the given password is correct, otherwise False
4372 public function checkPassword( $password ) {
4373 wfDeprecated( __METHOD__
, '1.27' );
4375 $manager = AuthManager
::singleton();
4376 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4377 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4379 'username' => $this->getName(),
4380 'password' => $password,
4383 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4384 switch ( $res->status
) {
4385 case AuthenticationResponse
::PASS
:
4387 case AuthenticationResponse
::FAIL
:
4388 // Hope it's not a PreAuthenticationProvider that failed...
4389 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4390 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4393 throw new BadMethodCallException(
4394 'AuthManager returned a response unsupported by ' . __METHOD__
4400 * Check if the given clear-text password matches the temporary password
4401 * sent by e-mail for password reset operations.
4403 * @deprecated since 1.27, use AuthManager instead
4404 * @param string $plaintext
4405 * @return bool True if matches, false otherwise
4407 public function checkTemporaryPassword( $plaintext ) {
4408 wfDeprecated( __METHOD__
, '1.27' );
4409 // Can't check the temporary password individually.
4410 return $this->checkPassword( $plaintext );
4414 * Initialize (if necessary) and return a session token value
4415 * which can be used in edit forms to show that the user's
4416 * login credentials aren't being hijacked with a foreign form
4420 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4421 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4422 * @return MediaWiki\Session\Token The new edit token
4424 public function getEditTokenObject( $salt = '', $request = null ) {
4425 if ( $this->isAnon() ) {
4426 return new LoggedOutEditToken();
4430 $request = $this->getRequest();
4432 return $request->getSession()->getToken( $salt );
4436 * Initialize (if necessary) and return a session token value
4437 * which can be used in edit forms to show that the user's
4438 * login credentials aren't being hijacked with a foreign form
4441 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4444 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4445 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4446 * @return string The new edit token
4448 public function getEditToken( $salt = '', $request = null ) {
4449 return $this->getEditTokenObject( $salt, $request )->toString();
4453 * Check given value against the token value stored in the session.
4454 * A match should confirm that the form was submitted from the
4455 * user's own login session, not a form submission from a third-party
4458 * @param string $val Input value to compare
4459 * @param string|array $salt Optional function-specific data for hashing
4460 * @param WebRequest|null $request Object to use or null to use $wgRequest
4461 * @param int|null $maxage Fail tokens older than this, in seconds
4462 * @return bool Whether the token matches
4464 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4465 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4469 * Check given value against the token value stored in the session,
4470 * ignoring the suffix.
4472 * @param string $val Input value to compare
4473 * @param string|array $salt Optional function-specific data for hashing
4474 * @param WebRequest|null $request Object to use or null to use $wgRequest
4475 * @param int|null $maxage Fail tokens older than this, in seconds
4476 * @return bool Whether the token matches
4478 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4479 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4480 return $this->matchEditToken( $val, $salt, $request, $maxage );
4484 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4485 * mail to the user's given address.
4487 * @param string $type Message to send, either "created", "changed" or "set"
4490 public function sendConfirmationMail( $type = 'created' ) {
4492 $expiration = null; // gets passed-by-ref and defined in next line.
4493 $token = $this->confirmationToken( $expiration );
4494 $url = $this->confirmationTokenUrl( $token );
4495 $invalidateURL = $this->invalidationTokenUrl( $token );
4496 $this->saveSettings();
4498 if ( $type == 'created' ||
$type === false ) {
4499 $message = 'confirmemail_body';
4501 } elseif ( $type === true ) {
4502 $message = 'confirmemail_body_changed';
4505 // Messages: confirmemail_body_changed, confirmemail_body_set
4506 $message = 'confirmemail_body_' . $type;
4510 'subject' => wfMessage( 'confirmemail_subject' )->text(),
4511 'body' => wfMessage( $message,
4512 $this->getRequest()->getIP(),
4515 $wgLang->userTimeAndDate( $expiration, $this ),
4517 $wgLang->userDate( $expiration, $this ),
4518 $wgLang->userTime( $expiration, $this ) )->text(),
4524 'ip' => $this->getRequest()->getIP(),
4525 'confirmURL' => $url,
4526 'invalidateURL' => $invalidateURL,
4527 'expiration' => $expiration
4530 Hooks
::run( 'UserSendConfirmationMail', [ $this, &$mail, $info ] );
4531 return $this->sendMail( $mail['subject'], $mail['body'], $mail['from'], $mail['replyTo'] );
4535 * Send an e-mail to this user's account. Does not check for
4536 * confirmed status or validity.
4538 * @param string $subject Message subject
4539 * @param string $body Message body
4540 * @param User|null $from Optional sending user; if unspecified, default
4541 * $wgPasswordSender will be used.
4542 * @param MailAddress|null $replyto Reply-To address
4545 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4546 global $wgPasswordSender;
4548 if ( $from instanceof User
) {
4549 $sender = MailAddress
::newFromUser( $from );
4551 $sender = new MailAddress( $wgPasswordSender,
4552 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4554 $to = MailAddress
::newFromUser( $this );
4556 return UserMailer
::send( $to, $sender, $subject, $body, [
4557 'replyTo' => $replyto,
4562 * Generate, store, and return a new e-mail confirmation code.
4563 * A hash (unsalted, since it's used as a key) is stored.
4565 * @note Call saveSettings() after calling this function to commit
4566 * this change to the database.
4568 * @param string &$expiration Accepts the expiration time
4569 * @return string New token
4571 protected function confirmationToken( &$expiration ) {
4572 global $wgUserEmailConfirmationTokenExpiry;
4574 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4575 $expiration = wfTimestamp( TS_MW
, $expires );
4577 $token = MWCryptRand
::generateHex( 32 );
4578 $hash = md5( $token );
4579 $this->mEmailToken
= $hash;
4580 $this->mEmailTokenExpires
= $expiration;
4585 * Return a URL the user can use to confirm their email address.
4586 * @param string $token Accepts the email confirmation token
4587 * @return string New token URL
4589 protected function confirmationTokenUrl( $token ) {
4590 return $this->getTokenUrl( 'ConfirmEmail', $token );
4594 * Return a URL the user can use to invalidate their email address.
4595 * @param string $token Accepts the email confirmation token
4596 * @return string New token URL
4598 protected function invalidationTokenUrl( $token ) {
4599 return $this->getTokenUrl( 'InvalidateEmail', $token );
4603 * Internal function to format the e-mail validation/invalidation URLs.
4604 * This uses a quickie hack to use the
4605 * hardcoded English names of the Special: pages, for ASCII safety.
4607 * @note Since these URLs get dropped directly into emails, using the
4608 * short English names avoids insanely long URL-encoded links, which
4609 * also sometimes can get corrupted in some browsers/mailers
4610 * (T8957 with Gmail and Internet Explorer).
4612 * @param string $page Special page
4613 * @param string $token
4614 * @return string Formatted URL
4616 protected function getTokenUrl( $page, $token ) {
4617 // Hack to bypass localization of 'Special:'
4618 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4619 return $title->getCanonicalURL();
4623 * Mark the e-mail address confirmed.
4625 * @note Call saveSettings() after calling this function to commit the change.
4629 public function confirmEmail() {
4630 // Check if it's already confirmed, so we don't touch the database
4631 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4632 if ( !$this->isEmailConfirmed() ) {
4633 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4634 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4640 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4641 * address if it was already confirmed.
4643 * @note Call saveSettings() after calling this function to commit the change.
4644 * @return bool Returns true
4646 public function invalidateEmail() {
4648 $this->mEmailToken
= null;
4649 $this->mEmailTokenExpires
= null;
4650 $this->setEmailAuthenticationTimestamp( null );
4652 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4657 * Set the e-mail authentication timestamp.
4658 * @param string $timestamp TS_MW timestamp
4660 public function setEmailAuthenticationTimestamp( $timestamp ) {
4662 $this->mEmailAuthenticated
= $timestamp;
4663 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4667 * Is this user allowed to send e-mails within limits of current
4668 * site configuration?
4671 public function canSendEmail() {
4672 global $wgEnableEmail, $wgEnableUserEmail;
4673 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4676 $canSend = $this->isEmailConfirmed();
4677 // Avoid PHP 7.1 warning of passing $this by reference
4679 Hooks
::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
4684 * Is this user allowed to receive e-mails within limits of current
4685 * site configuration?
4688 public function canReceiveEmail() {
4689 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4693 * Is this user's e-mail address valid-looking and confirmed within
4694 * limits of the current site configuration?
4696 * @note If $wgEmailAuthentication is on, this may require the user to have
4697 * confirmed their address by returning a code or using a password
4698 * sent to the address from the wiki.
4702 public function isEmailConfirmed() {
4703 global $wgEmailAuthentication;
4705 // Avoid PHP 7.1 warning of passing $this by reference
4708 if ( Hooks
::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
4709 if ( $this->isAnon() ) {
4712 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4715 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4725 * Check whether there is an outstanding request for e-mail confirmation.
4728 public function isEmailConfirmationPending() {
4729 global $wgEmailAuthentication;
4730 return $wgEmailAuthentication &&
4731 !$this->isEmailConfirmed() &&
4732 $this->mEmailToken
&&
4733 $this->mEmailTokenExpires
> wfTimestamp();
4737 * Get the timestamp of account creation.
4739 * @return string|bool|null Timestamp of account creation, false for
4740 * non-existent/anonymous user accounts, or null if existing account
4741 * but information is not in database.
4743 public function getRegistration() {
4744 if ( $this->isAnon() ) {
4748 return $this->mRegistration
;
4752 * Get the timestamp of the first edit
4754 * @return string|bool Timestamp of first edit, or false for
4755 * non-existent/anonymous user accounts.
4757 public function getFirstEditTimestamp() {
4758 return $this->getEditTimestamp( true );
4762 * Get the timestamp of the latest edit
4765 * @return string|bool Timestamp of first edit, or false for
4766 * non-existent/anonymous user accounts.
4768 public function getLatestEditTimestamp() {
4769 return $this->getEditTimestamp( false );
4773 * Get the timestamp of the first or latest edit
4775 * @param bool $first True for the first edit, false for the latest one
4776 * @return string|bool Timestamp of first or latest edit, or false for
4777 * non-existent/anonymous user accounts.
4779 private function getEditTimestamp( $first ) {
4780 if ( $this->getId() == 0 ) {
4781 return false; // anons
4783 $dbr = wfGetDB( DB_REPLICA
);
4784 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
4785 $tsField = isset( $actorWhere['tables']['temp_rev_user'] )
4786 ?
'revactor_timestamp' : 'rev_timestamp';
4787 $sortOrder = $first ?
'ASC' : 'DESC';
4788 $time = $dbr->selectField(
4789 [ 'revision' ] +
$actorWhere['tables'],
4791 [ $actorWhere['conds'] ],
4793 [ 'ORDER BY' => "$tsField $sortOrder" ],
4794 $actorWhere['joins']
4797 return false; // no edits
4799 return wfTimestamp( TS_MW
, $time );
4803 * Get the permissions associated with a given list of groups
4805 * @deprecated since 1.34, use MediaWikiServices::getInstance()->getPermissionManager()
4806 * ->getGroupPermissions() instead
4808 * @param array $groups Array of Strings List of internal group names
4809 * @return array Array of Strings List of permission key names for given groups combined
4811 public static function getGroupPermissions( $groups ) {
4812 return MediaWikiServices
::getInstance()->getPermissionManager()->getGroupPermissions( $groups );
4816 * Get all the groups who have a given permission
4818 * @deprecated since 1.34, use MediaWikiServices::getInstance()->getPermissionManager()
4819 * ->getGroupsWithPermission() instead
4821 * @param string $role Role to check
4822 * @return array Array of Strings List of internal group names with the given permission
4824 public static function getGroupsWithPermission( $role ) {
4825 return MediaWikiServices
::getInstance()->getPermissionManager()->getGroupsWithPermission( $role );
4829 * Check, if the given group has the given permission
4831 * If you're wanting to check whether all users have a permission, use
4832 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4835 * @deprecated since 1.34, use MediaWikiServices::getInstance()->getPermissionManager()
4836 * ->groupHasPermission(..) instead
4839 * @param string $group Group to check
4840 * @param string $role Role to check
4843 public static function groupHasPermission( $group, $role ) {
4844 return MediaWikiServices
::getInstance()->getPermissionManager()
4845 ->groupHasPermission( $group, $role );
4849 * Check if all users may be assumed to have the given permission
4851 * We generally assume so if the right is granted to '*' and isn't revoked
4852 * on any group. It doesn't attempt to take grants or other extension
4853 * limitations on rights into account in the general case, though, as that
4854 * would require it to always return false and defeat the purpose.
4855 * Specifically, session-based rights restrictions (such as OAuth or bot
4856 * passwords) are applied based on the current session.
4858 * @deprecated since 1.34, use MediaWikiServices::getInstance()->getPermissionManager()
4859 * ->isEveryoneAllowed() instead
4861 * @param string $right Right to check
4866 public static function isEveryoneAllowed( $right ) {
4867 return MediaWikiServices
::getInstance()->getPermissionManager()->isEveryoneAllowed( $right );
4871 * Return the set of defined explicit groups.
4872 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4873 * are not included, as they are defined automatically, not in the database.
4874 * @return array Array of internal group names
4876 public static function getAllGroups() {
4877 global $wgGroupPermissions, $wgRevokePermissions;
4878 return array_values( array_diff(
4879 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4880 self
::getImplicitGroups()
4885 * Get a list of all available permissions.
4887 * @deprecated since 1.34, use PermissionManager::getAllPermissions() instead
4889 * @return string[] Array of permission names
4891 public static function getAllRights() {
4892 return MediaWikiServices
::getInstance()->getPermissionManager()->getAllPermissions();
4896 * Get a list of implicit groups
4897 * TODO: Should we deprecate this? It's trivial, but we don't want to encourage use of globals.
4899 * @return array Array of Strings Array of internal group names
4901 public static function getImplicitGroups() {
4902 global $wgImplicitGroups;
4903 return $wgImplicitGroups;
4907 * Returns an array of the groups that a particular group can add/remove.
4909 * @param string $group The group to check for whether it can add/remove
4910 * @return array [ 'add' => [ addablegroups ],
4911 * 'remove' => [ removablegroups ],
4912 * 'add-self' => [ addablegroups to self ],
4913 * 'remove-self' => [ removable groups from self ] ]
4915 public static function changeableByGroup( $group ) {
4916 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4925 if ( empty( $wgAddGroups[$group] ) ) {
4926 // Don't add anything to $groups
4927 } elseif ( $wgAddGroups[$group] === true ) {
4928 // You get everything
4929 $groups['add'] = self
::getAllGroups();
4930 } elseif ( is_array( $wgAddGroups[$group] ) ) {
4931 $groups['add'] = $wgAddGroups[$group];
4934 // Same thing for remove
4935 if ( empty( $wgRemoveGroups[$group] ) ) {
4937 } elseif ( $wgRemoveGroups[$group] === true ) {
4938 $groups['remove'] = self
::getAllGroups();
4939 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4940 $groups['remove'] = $wgRemoveGroups[$group];
4943 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4944 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
4945 foreach ( $wgGroupsAddToSelf as $key => $value ) {
4946 if ( is_int( $key ) ) {
4947 $wgGroupsAddToSelf['user'][] = $value;
4952 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
4953 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4954 if ( is_int( $key ) ) {
4955 $wgGroupsRemoveFromSelf['user'][] = $value;
4960 // Now figure out what groups the user can add to him/herself
4961 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
4963 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
4964 // No idea WHY this would be used, but it's there
4965 $groups['add-self'] = self
::getAllGroups();
4966 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4967 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4970 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4972 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4973 $groups['remove-self'] = self
::getAllGroups();
4974 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4975 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4982 * Returns an array of groups that this user can add and remove
4983 * @return array [ 'add' => [ addablegroups ],
4984 * 'remove' => [ removablegroups ],
4985 * 'add-self' => [ addablegroups to self ],
4986 * 'remove-self' => [ removable groups from self ] ]
4988 public function changeableGroups() {
4989 if ( $this->isAllowed( 'userrights' ) ) {
4990 // This group gives the right to modify everything (reverse-
4991 // compatibility with old "userrights lets you change
4993 // Using array_merge to make the groups reindexed
4994 $all = array_merge( self
::getAllGroups() );
5003 // Okay, it's not so simple, we will have to go through the arrays
5010 $addergroups = $this->getEffectiveGroups();
5012 foreach ( $addergroups as $addergroup ) {
5013 $groups = array_merge_recursive(
5014 $groups, $this->changeableByGroup( $addergroup )
5016 $groups['add'] = array_unique( $groups['add'] );
5017 $groups['remove'] = array_unique( $groups['remove'] );
5018 $groups['add-self'] = array_unique( $groups['add-self'] );
5019 $groups['remove-self'] = array_unique( $groups['remove-self'] );
5025 * Schedule a deferred update to update the user's edit count
5027 public function incEditCount() {
5028 if ( $this->isAnon() ) {
5032 DeferredUpdates
::addUpdate(
5033 new UserEditCountUpdate( $this, 1 ),
5034 DeferredUpdates
::POSTSEND
5039 * This method should not be called outside User/UserEditCountUpdate
5043 public function setEditCountInternal( $count ) {
5044 $this->mEditCount
= $count;
5048 * Initialize user_editcount from data out of the revision table
5050 * @internal This method should not be called outside User/UserEditCountUpdate
5051 * @param IDatabase $dbr Replica database
5052 * @return int Number of edits
5054 public function initEditCountInternal( IDatabase
$dbr ) {
5055 // Pull from a replica DB to be less cruel to servers
5056 // Accuracy isn't the point anyway here
5057 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5058 $count = (int)$dbr->selectField(
5059 [ 'revision' ] +
$actorWhere['tables'],
5061 [ $actorWhere['conds'] ],
5064 $actorWhere['joins']
5067 $dbw = wfGetDB( DB_MASTER
);
5070 [ 'user_editcount' => $count ],
5072 'user_id' => $this->getId(),
5073 'user_editcount IS NULL OR user_editcount < ' . (int)$count
5082 * Get the description of a given right
5085 * @param string $right Right to query
5086 * @return string Localized description of the right
5088 public static function getRightDescription( $right ) {
5089 $key = "right-$right";
5090 $msg = wfMessage( $key );
5091 return $msg->isDisabled() ?
$right : $msg->text();
5095 * Get the name of a given grant
5098 * @param string $grant Grant to query
5099 * @return string Localized name of the grant
5101 public static function getGrantName( $grant ) {
5102 $key = "grant-$grant";
5103 $msg = wfMessage( $key );
5104 return $msg->isDisabled() ?
$grant : $msg->text();
5108 * Add a newuser log entry for this user.
5109 * Before 1.19 the return value was always true.
5111 * @deprecated since 1.27, AuthManager handles logging
5112 * @param string|bool $action Account creation type.
5113 * - String, one of the following values:
5114 * - 'create' for an anonymous user creating an account for himself.
5115 * This will force the action's performer to be the created user itself,
5116 * no matter the value of $wgUser
5117 * - 'create2' for a logged in user creating an account for someone else
5118 * - 'byemail' when the created user will receive its password by e-mail
5119 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5120 * - Boolean means whether the account was created by e-mail (deprecated):
5121 * - true will be converted to 'byemail'
5122 * - false will be converted to 'create' if this object is the same as
5123 * $wgUser and to 'create2' otherwise
5124 * @param string $reason User supplied reason
5127 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5128 return true; // disabled
5132 * Add an autocreate newuser log entry for this user
5133 * Used by things like CentralAuth and perhaps other authplugins.
5134 * Consider calling addNewUserLogEntry() directly instead.
5136 * @deprecated since 1.27, AuthManager handles logging
5139 public function addNewUserLogEntryAutoCreate() {
5140 wfDeprecated( __METHOD__
, '1.27' );
5141 $this->addNewUserLogEntry( 'autocreate' );
5147 * Load the user options either from cache, the database or an array
5149 * @param array|null $data Rows for the current user out of the user_properties table
5151 protected function loadOptions( $data = null ) {
5154 if ( $this->mOptionsLoaded
) {
5158 $this->mOptions
= self
::getDefaultOptions();
5160 if ( !$this->getId() ) {
5161 // For unlogged-in users, load language/variant options from request.
5162 // There's no need to do it for logged-in users: they can set preferences,
5163 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5164 // so don't override user's choice (especially when the user chooses site default).
5165 $variant = MediaWikiServices
::getInstance()->getContentLanguage()->getDefaultVariant();
5166 $this->mOptions
['variant'] = $variant;
5167 $this->mOptions
['language'] = $variant;
5168 $this->mOptionsLoaded
= true;
5172 // Maybe load from the object
5173 if ( !is_null( $this->mOptionOverrides
) ) {
5174 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5175 foreach ( $this->mOptionOverrides
as $key => $value ) {
5176 $this->mOptions
[$key] = $value;
5179 if ( !is_array( $data ) ) {
5180 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5181 // Load from database
5182 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5183 ?
wfGetDB( DB_MASTER
)
5184 : wfGetDB( DB_REPLICA
);
5186 $res = $dbr->select(
5188 [ 'up_property', 'up_value' ],
5189 [ 'up_user' => $this->getId() ],
5193 $this->mOptionOverrides
= [];
5195 foreach ( $res as $row ) {
5196 // Convert '0' to 0. PHP's boolean conversion considers them both
5197 // false, but e.g. JavaScript considers the former as true.
5198 // @todo: T54542 Somehow determine the desired type (string/int/bool)
5199 // and convert all values here.
5200 if ( $row->up_value
=== '0' ) {
5203 $data[$row->up_property
] = $row->up_value
;
5207 foreach ( $data as $property => $value ) {
5208 $this->mOptionOverrides
[$property] = $value;
5209 $this->mOptions
[$property] = $value;
5213 // Replace deprecated language codes
5214 $this->mOptions
['language'] = LanguageCode
::replaceDeprecatedCodes(
5215 $this->mOptions
['language']
5218 $this->mOptionsLoaded
= true;
5220 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5224 * Saves the non-default options for this user, as previously set e.g. via
5225 * setOption(), in the database's "user_properties" (preferences) table.
5226 * Usually used via saveSettings().
5228 protected function saveOptions() {
5229 $this->loadOptions();
5231 // Not using getOptions(), to keep hidden preferences in database
5232 $saveOptions = $this->mOptions
;
5234 // Allow hooks to abort, for instance to save to a global profile.
5235 // Reset options to default state before saving.
5236 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5240 $userId = $this->getId();
5242 $insert_rows = []; // all the new preference rows
5243 foreach ( $saveOptions as $key => $value ) {
5244 // Don't bother storing default values
5245 $defaultOption = self
::getDefaultOption( $key );
5246 if ( ( $defaultOption === null && $value !== false && $value !== null )
5247 ||
$value != $defaultOption
5250 'up_user' => $userId,
5251 'up_property' => $key,
5252 'up_value' => $value,
5257 $dbw = wfGetDB( DB_MASTER
);
5259 $res = $dbw->select( 'user_properties',
5260 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5262 // Find prior rows that need to be removed or updated. These rows will
5263 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5265 foreach ( $res as $row ) {
5266 if ( !isset( $saveOptions[$row->up_property
] )
5267 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5269 $keysDelete[] = $row->up_property
;
5273 if ( count( $keysDelete ) ) {
5274 // Do the DELETE by PRIMARY KEY for prior rows.
5275 // In the past a very large portion of calls to this function are for setting
5276 // 'rememberpassword' for new accounts (a preference that has since been removed).
5277 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5278 // caused gap locks on [max user ID,+infinity) which caused high contention since
5279 // updates would pile up on each other as they are for higher (newer) user IDs.
5280 // It might not be necessary these days, but it shouldn't hurt either.
5281 $dbw->delete( 'user_properties',
5282 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5284 // Insert the new preference rows
5285 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5289 * Return the list of user fields that should be selected to create
5290 * a new user object.
5291 * @deprecated since 1.31, use self::getQueryInfo() instead.
5294 public static function selectFields() {
5295 wfDeprecated( __METHOD__
, '1.31' );
5303 'user_email_authenticated',
5305 'user_email_token_expires',
5306 'user_registration',
5312 * Return the tables, fields, and join conditions to be selected to create
5313 * a new user object.
5315 * @return array With three keys:
5316 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
5317 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
5318 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
5320 public static function getQueryInfo() {
5321 global $wgActorTableSchemaMigrationStage;
5324 'tables' => [ 'user' ],
5332 'user_email_authenticated',
5334 'user_email_token_expires',
5335 'user_registration',
5341 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
5342 // but it does little harm and might be needed for write callers loading a User.
5343 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
5344 $ret['tables']['user_actor'] = 'actor';
5345 $ret['fields'][] = 'user_actor.actor_id';
5346 $ret['joins']['user_actor'] = [
5347 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) ?
'JOIN' : 'LEFT JOIN',
5348 [ 'user_actor.actor_user = user_id' ]
5356 * Factory function for fatal permission-denied errors
5359 * @param string $permission User right required
5362 static function newFatalPermissionDeniedStatus( $permission ) {
5366 foreach ( MediaWikiServices
::getInstance()
5367 ->getPermissionManager()
5368 ->getGroupsWithPermission( $permission ) as $group ) {
5369 $groups[] = UserGroupMembership
::getLink( $group, RequestContext
::getMain(), 'wiki' );
5373 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5376 return Status
::newFatal( 'badaccess-group0' );
5380 * Get a new instance of this user that was loaded from the master via a locking read
5382 * Use this instead of the main context User when updating that user. This avoids races
5383 * where that user was loaded from a replica DB or even the master but without proper locks.
5385 * @return User|null Returns null if the user was not found in the DB
5388 public function getInstanceForUpdate() {
5389 if ( !$this->getId() ) {
5390 return null; // anon
5393 $user = self
::newFromId( $this->getId() );
5394 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5402 * Checks if two user objects point to the same user.
5404 * @since 1.25 ; takes a UserIdentity instead of a User since 1.32
5405 * @param UserIdentity $user
5408 public function equals( UserIdentity
$user ) {
5409 // XXX it's not clear whether central ID providers are supposed to obey this
5410 return $this->getName() === $user->getName();
5414 * Checks if usertalk is allowed
5418 public function isAllowUsertalk() {
5419 return $this->mAllowUsertalk
;