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
115 * @var string[] Cached results of getAllRights()
117 protected static $mAllRights = false;
119 /** Cache variables */
132 /** @var string TS_MW timestamp from the DB */
134 /** @var string TS_MW timestamp from cache */
135 protected $mQuickTouched;
139 public $mEmailAuthenticated;
141 protected $mEmailToken;
143 protected $mEmailTokenExpires;
145 protected $mRegistration;
147 protected $mEditCount;
148 /** @var UserGroupMembership[] Associative array of (group name => UserGroupMembership object) */
149 protected $mGroupMemberships;
151 protected $mOptionOverrides;
156 * @var bool Whether the cache variables have been loaded.
158 public $mOptionsLoaded;
161 * @var array|bool Array with already loaded items or true if all items have been loaded.
163 protected $mLoadedItems = [];
167 * @var string Initialization data source if mLoadedItems!==true. May be one of:
168 * - 'defaults' anonymous user initialised from class defaults
169 * - 'name' initialise from mName
170 * - 'id' initialise from mId
171 * - 'actor' initialise from mActorId
172 * - 'session' log in from session if possible
174 * Use the User::newFrom*() family of functions to set this.
179 * Lazy-initialized variables, invalidated with clearInstanceCache
184 protected $mDatePreference;
190 protected $mBlockreason;
192 protected $mEffectiveGroups;
194 protected $mImplicitGroups;
196 protected $mFormerGroups;
197 /** @var AbstractBlock */
198 protected $mGlobalBlock;
206 /** @var WebRequest */
209 /** @var AbstractBlock */
213 protected $mAllowUsertalk;
215 /** @var AbstractBlock|bool */
216 private $mBlockedFromCreateAccount = false;
218 /** @var int User::READ_* constant bitfield used to load data */
219 protected $queryFlagsUsed = self
::READ_NORMAL
;
222 public static $idCacheByName = [];
225 * Lightweight constructor for an anonymous user.
226 * Use the User::newFrom* factory functions for other kinds of users.
230 * @see newFromActorId()
231 * @see newFromConfirmationCode()
232 * @see newFromSession()
235 public function __construct() {
236 $this->clearInstanceCache( 'defaults' );
242 public function __toString() {
243 return (string)$this->getName();
246 public function &__get( $name ) {
247 // A shortcut for $mRights deprecation phase
248 if ( $name === 'mRights' ) {
249 $copy = $this->getRights();
251 } elseif ( !property_exists( $this, $name ) ) {
252 // T227688 - do not break $u->foo['bar'] = 1
253 wfLogWarning( 'tried to get non-existent property' );
257 wfLogWarning( 'tried to get non-visible property' );
262 public function __set( $name, $value ) {
263 // A shortcut for $mRights deprecation phase, only known legitimate use was for
264 // testing purposes, other uses seem bad in principle
265 if ( $name === 'mRights' ) {
266 MediaWikiServices
::getInstance()->getPermissionManager()->overrideUserRightsForTesting(
268 is_null( $value ) ?
[] : $value
270 } elseif ( !property_exists( $this, $name ) ) {
271 $this->$name = $value;
273 wfLogWarning( 'tried to set non-visible property' );
278 * Test if it's safe to load this User object.
280 * You should typically check this before using $wgUser or
281 * RequestContext::getUser in a method that might be called before the
282 * system has been fully initialized. If the object is unsafe, you should
283 * use an anonymous user:
285 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
291 public function isSafeToLoad() {
292 global $wgFullyInitialised;
294 // The user is safe to load if:
295 // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
296 // * mLoadedItems === true (already loaded)
297 // * mFrom !== 'session' (sessions not involved at all)
299 return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
300 $this->mLoadedItems
=== true ||
$this->mFrom
!== 'session';
304 * Load the user table data for this object from the source given by mFrom.
306 * @param int $flags User::READ_* constant bitfield
308 public function load( $flags = self
::READ_NORMAL
) {
309 global $wgFullyInitialised;
311 if ( $this->mLoadedItems
=== true ) {
315 // Set it now to avoid infinite recursion in accessors
316 $oldLoadedItems = $this->mLoadedItems
;
317 $this->mLoadedItems
= true;
318 $this->queryFlagsUsed
= $flags;
320 // If this is called too early, things are likely to break.
321 if ( !$wgFullyInitialised && $this->mFrom
=== 'session' ) {
322 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
323 ->warning( 'User::loadFromSession called before the end of Setup.php', [
324 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
326 $this->loadDefaults();
327 $this->mLoadedItems
= $oldLoadedItems;
331 switch ( $this->mFrom
) {
333 $this->loadDefaults();
336 // Make sure this thread sees its own changes
337 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
338 if ( $lb->hasOrMadeRecentMasterChanges() ) {
339 $flags |
= self
::READ_LATEST
;
340 $this->queryFlagsUsed
= $flags;
343 $this->mId
= self
::idFromName( $this->mName
, $flags );
345 // Nonexistent user placeholder object
346 $this->loadDefaults( $this->mName
);
348 $this->loadFromId( $flags );
352 // Make sure this thread sees its own changes, if the ID isn't 0
353 if ( $this->mId
!= 0 ) {
354 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
355 if ( $lb->hasOrMadeRecentMasterChanges() ) {
356 $flags |
= self
::READ_LATEST
;
357 $this->queryFlagsUsed
= $flags;
361 $this->loadFromId( $flags );
364 // Make sure this thread sees its own changes
365 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
366 if ( $lb->hasOrMadeRecentMasterChanges() ) {
367 $flags |
= self
::READ_LATEST
;
368 $this->queryFlagsUsed
= $flags;
371 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
372 $row = wfGetDB( $index )->selectRow(
374 [ 'actor_user', 'actor_name' ],
375 [ 'actor_id' => $this->mActorId
],
382 $this->loadDefaults();
383 } elseif ( $row->actor_user
) {
384 $this->mId
= $row->actor_user
;
385 $this->loadFromId( $flags );
387 $this->loadDefaults( $row->actor_name
);
391 if ( !$this->loadFromSession() ) {
392 // Loading from session failed. Load defaults.
393 $this->loadDefaults();
395 Hooks
::run( 'UserLoadAfterLoadFromSession', [ $this ] );
398 throw new UnexpectedValueException(
399 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
404 * Load user table data, given mId has already been set.
405 * @param int $flags User::READ_* constant bitfield
406 * @return bool False if the ID does not exist, true otherwise
408 public function loadFromId( $flags = self
::READ_NORMAL
) {
409 if ( $this->mId
== 0 ) {
410 // Anonymous users are not in the database (don't need cache)
411 $this->loadDefaults();
415 // Try cache (unless this needs data from the master DB).
416 // NOTE: if this thread called saveSettings(), the cache was cleared.
417 $latest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
419 if ( !$this->loadFromDatabase( $flags ) ) {
420 // Can't load from ID
424 $this->loadFromCache();
427 $this->mLoadedItems
= true;
428 $this->queryFlagsUsed
= $flags;
435 * @param string $dbDomain
438 public static function purge( $dbDomain, $userId ) {
439 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
440 $key = $cache->makeGlobalKey( 'user', 'id', $dbDomain, $userId );
441 $cache->delete( $key );
446 * @param WANObjectCache $cache
449 protected function getCacheKey( WANObjectCache
$cache ) {
450 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
452 return $cache->makeGlobalKey( 'user', 'id', $lbFactory->getLocalDomainID(), $this->mId
);
456 * @param WANObjectCache $cache
460 public function getMutableCacheKeys( WANObjectCache
$cache ) {
461 $id = $this->getId();
463 return $id ?
[ $this->getCacheKey( $cache ) ] : [];
467 * Load user data from shared cache, given mId has already been set.
472 protected function loadFromCache() {
473 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
474 $data = $cache->getWithSetCallback(
475 $this->getCacheKey( $cache ),
477 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
478 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
479 wfDebug( "User: cache miss for user {$this->mId}\n" );
481 $this->loadFromDatabase( self
::READ_NORMAL
);
483 $this->loadOptions();
486 foreach ( self
::$mCacheVars as $name ) {
487 $data[$name] = $this->$name;
490 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->mTouched
), $ttl );
492 // if a user group membership is about to expire, the cache needs to
493 // expire at that time (T163691)
494 foreach ( $this->mGroupMemberships
as $ugm ) {
495 if ( $ugm->getExpiry() ) {
496 $secondsUntilExpiry = wfTimestamp( TS_UNIX
, $ugm->getExpiry() ) - time();
497 if ( $secondsUntilExpiry > 0 && $secondsUntilExpiry < $ttl ) {
498 $ttl = $secondsUntilExpiry;
505 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'version' => self
::VERSION
]
508 // Restore from cache
509 foreach ( self
::$mCacheVars as $name ) {
510 $this->$name = $data[$name];
516 /** @name newFrom*() static factory methods */
520 * Static factory method for creation from username.
522 * This is slightly less efficient than newFromId(), so use newFromId() if
523 * you have both an ID and a name handy.
525 * @param string $name Username, validated by Title::newFromText()
526 * @param string|bool $validate Validate username. Takes the same parameters as
527 * User::getCanonicalName(), except that true is accepted as an alias
528 * for 'valid', for BC.
530 * @return User|bool User object, or false if the username is invalid
531 * (e.g. if it contains illegal characters or is an IP address). If the
532 * username is not present in the database, the result will be a user object
533 * with a name, zero user ID and default settings.
535 public static function newFromName( $name, $validate = 'valid' ) {
536 if ( $validate === true ) {
539 $name = self
::getCanonicalName( $name, $validate );
540 if ( $name === false ) {
544 // Create unloaded user object
548 $u->setItemLoaded( 'name' );
554 * Static factory method for creation from a given user ID.
556 * @param int $id Valid user ID
557 * @return User The corresponding User object
559 public static function newFromId( $id ) {
563 $u->setItemLoaded( 'id' );
568 * Static factory method for creation from a given actor ID.
571 * @param int $id Valid actor ID
572 * @return User The corresponding User object
574 public static function newFromActorId( $id ) {
575 global $wgActorTableSchemaMigrationStage;
577 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
578 // but it does little harm and might be needed for write callers loading a User.
579 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) ) {
580 throw new BadMethodCallException(
581 'Cannot use ' . __METHOD__
582 . ' when $wgActorTableSchemaMigrationStage lacks SCHEMA_COMPAT_NEW'
589 $u->setItemLoaded( 'actor' );
594 * Returns a User object corresponding to the given UserIdentity.
598 * @param UserIdentity $identity
602 public static function newFromIdentity( UserIdentity
$identity ) {
603 if ( $identity instanceof User
) {
607 return self
::newFromAnyId(
608 $identity->getId() === 0 ?
null : $identity->getId(),
609 $identity->getName() === '' ?
null : $identity->getName(),
610 $identity->getActorId() === 0 ?
null : $identity->getActorId()
615 * Static factory method for creation from an ID, name, and/or actor ID
617 * This does not check that the ID, name, and actor ID all correspond to
621 * @param int|null $userId User ID, if known
622 * @param string|null $userName User name, if known
623 * @param int|null $actorId Actor ID, if known
624 * @param bool|string $dbDomain remote wiki to which the User/Actor ID applies, or false if none
627 public static function newFromAnyId( $userId, $userName, $actorId, $dbDomain = false ) {
628 global $wgActorTableSchemaMigrationStage;
630 // Stop-gap solution for the problem described in T222212.
631 // Force the User ID and Actor ID to zero for users loaded from the database
632 // of another wiki, to prevent subtle data corruption and confusing failure modes.
633 if ( $dbDomain !== false ) {
639 $user->mFrom
= 'defaults';
641 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
642 // but it does little harm and might be needed for write callers loading a User.
643 if ( ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) && $actorId !== null ) {
644 $user->mActorId
= (int)$actorId;
645 if ( $user->mActorId
!== 0 ) {
646 $user->mFrom
= 'actor';
648 $user->setItemLoaded( 'actor' );
651 if ( $userName !== null && $userName !== '' ) {
652 $user->mName
= $userName;
653 $user->mFrom
= 'name';
654 $user->setItemLoaded( 'name' );
657 if ( $userId !== null ) {
658 $user->mId
= (int)$userId;
659 if ( $user->mId
!== 0 ) {
662 $user->setItemLoaded( 'id' );
665 if ( $user->mFrom
=== 'defaults' ) {
666 throw new InvalidArgumentException(
667 'Cannot create a user with no name, no ID, and no actor ID'
675 * Factory method to fetch whichever user has a given email confirmation code.
676 * This code is generated when an account is created or its e-mail address
679 * If the code is invalid or has expired, returns NULL.
681 * @param string $code Confirmation code
682 * @param int $flags User::READ_* bitfield
685 public static function newFromConfirmationCode( $code, $flags = 0 ) {
686 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
687 ?
wfGetDB( DB_MASTER
)
688 : wfGetDB( DB_REPLICA
);
690 $id = $db->selectField(
694 'user_email_token' => md5( $code ),
695 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
699 return $id ? self
::newFromId( $id ) : null;
703 * Create a new user object using data from session. If the login
704 * credentials are invalid, the result is an anonymous user.
706 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
709 public static function newFromSession( WebRequest
$request = null ) {
711 $user->mFrom
= 'session';
712 $user->mRequest
= $request;
717 * Create a new user object from a user row.
718 * The row should have the following fields from the user table in it:
719 * - either user_name or user_id to load further data if needed (or both)
721 * - all other fields (email, etc.)
722 * It is useless to provide the remaining fields if either user_id,
723 * user_name and user_real_name are not provided because the whole row
724 * will be loaded once more from the database when accessing them.
726 * @param stdClass $row A row from the user table
727 * @param array|null $data Further data to load into the object
728 * (see User::loadFromRow for valid keys)
731 public static function newFromRow( $row, $data = null ) {
733 $user->loadFromRow( $row, $data );
738 * Static factory method for creation of a "system" user from username.
740 * A "system" user is an account that's used to attribute logged actions
741 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
742 * might include the 'Maintenance script' or 'Conversion script' accounts
743 * used by various scripts in the maintenance/ directory or accounts such
744 * as 'MediaWiki message delivery' used by the MassMessage extension.
746 * This can optionally create the user if it doesn't exist, and "steal" the
747 * account if it does exist.
749 * "Stealing" an existing user is intended to make it impossible for normal
750 * authentication processes to use the account, effectively disabling the
751 * account for normal use:
752 * - Email is invalidated, to prevent account recovery by emailing a
753 * temporary password and to disassociate the account from the existing
755 * - The token is set to a magic invalid value, to kill existing sessions
756 * and to prevent $this->setToken() calls from resetting the token to a
758 * - SessionManager is instructed to prevent new sessions for the user, to
759 * do things like deauthorizing OAuth consumers.
760 * - AuthManager is instructed to revoke access, to invalidate or remove
761 * passwords and other credentials.
763 * @param string $name Username
764 * @param array $options Options are:
765 * - validate: As for User::getCanonicalName(), default 'valid'
766 * - create: Whether to create the user if it doesn't already exist, default true
767 * - steal: Whether to "disable" the account for normal use if it already
768 * exists, default false
772 public static function newSystemUser( $name, $options = [] ) {
774 'validate' => 'valid',
779 $name = self
::getCanonicalName( $name, $options['validate'] );
780 if ( $name === false ) {
784 $dbr = wfGetDB( DB_REPLICA
);
785 $userQuery = self
::getQueryInfo();
786 $row = $dbr->selectRow(
787 $userQuery['tables'],
788 $userQuery['fields'],
789 [ 'user_name' => $name ],
795 // Try the master database...
796 $dbw = wfGetDB( DB_MASTER
);
797 $row = $dbw->selectRow(
798 $userQuery['tables'],
799 $userQuery['fields'],
800 [ 'user_name' => $name ],
808 // No user. Create it?
809 return $options['create']
810 ? self
::createNew( $name, [ 'token' => self
::INVALID_TOKEN
] )
814 $user = self
::newFromRow( $row );
816 // A user is considered to exist as a non-system user if it can
817 // authenticate, or has an email set, or has a non-invalid token.
818 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
819 AuthManager
::singleton()->userCanAuthenticate( $name )
821 // User exists. Steal it?
822 if ( !$options['steal'] ) {
826 AuthManager
::singleton()->revokeAccessForUser( $name );
828 $user->invalidateEmail();
829 $user->mToken
= self
::INVALID_TOKEN
;
830 $user->saveSettings();
831 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
840 * Get the username corresponding to a given user ID
841 * @param int $id User ID
842 * @return string|bool The corresponding username
844 public static function whoIs( $id ) {
845 return UserCache
::singleton()->getProp( $id, 'name' );
849 * Get the real name of a user given their user ID
851 * @param int $id User ID
852 * @return string|bool The corresponding user's real name
854 public static function whoIsReal( $id ) {
855 return UserCache
::singleton()->getProp( $id, 'real_name' );
859 * Get database id given a user name
860 * @param string $name Username
861 * @param int $flags User::READ_* constant bitfield
862 * @return int|null The corresponding user's ID, or null if user is nonexistent
864 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
865 // Don't explode on self::$idCacheByName[$name] if $name is not a string but e.g. a User object
866 $name = (string)$name;
867 $nt = Title
::makeTitleSafe( NS_USER
, $name );
868 if ( is_null( $nt ) ) {
873 if ( !( $flags & self
::READ_LATEST
) && array_key_exists( $name, self
::$idCacheByName ) ) {
874 return is_null( self
::$idCacheByName[$name] ) ?
null : (int)self
::$idCacheByName[$name];
877 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
878 $db = wfGetDB( $index );
883 [ 'user_name' => $nt->getText() ],
888 if ( $s === false ) {
891 $result = (int)$s->user_id
;
894 if ( count( self
::$idCacheByName ) >= 1000 ) {
895 self
::$idCacheByName = [];
898 self
::$idCacheByName[$name] = $result;
904 * Reset the cache used in idFromName(). For use in tests.
906 public static function resetIdByNameCache() {
907 self
::$idCacheByName = [];
911 * Does the string match an anonymous IP address?
913 * This function exists for username validation, in order to reject
914 * usernames which are similar in form to IP addresses. Strings such
915 * as 300.300.300.300 will return true because it looks like an IP
916 * address, despite not being strictly valid.
918 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
919 * address because the usemod software would "cloak" anonymous IP
920 * addresses like this, if we allowed accounts like this to be created
921 * new users could get the old edits of these anonymous users.
923 * @param string $name Name to match
926 public static function isIP( $name ) {
927 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
928 || IP
::isIPv6( $name );
932 * Is the user an IP range?
937 public function isIPRange() {
938 return IP
::isValidRange( $this->mName
);
942 * Is the input a valid username?
944 * Checks if the input is a valid username, we don't want an empty string,
945 * an IP address, anything that contains slashes (would mess up subpages),
946 * is longer than the maximum allowed username size or doesn't begin with
949 * @param string $name Name to match
952 public static function isValidUserName( $name ) {
953 global $wgMaxNameChars;
956 || self
::isIP( $name )
957 ||
strpos( $name, '/' ) !== false
958 ||
strlen( $name ) > $wgMaxNameChars
959 ||
$name != MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name )
964 // Ensure that the name can't be misresolved as a different title,
965 // such as with extra namespace keys at the start.
966 $parsed = Title
::newFromText( $name );
967 if ( is_null( $parsed )
968 ||
$parsed->getNamespace()
969 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
973 // Check an additional blacklist of troublemaker characters.
974 // Should these be merged into the title char list?
975 $unicodeBlacklist = '/[' .
976 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
977 '\x{00a0}' . # non-breaking space
978 '\x{2000}-\x{200f}' . # various whitespace
979 '\x{2028}-\x{202f}' . # breaks and control chars
980 '\x{3000}' . # ideographic space
981 '\x{e000}-\x{f8ff}' . # private use
983 if ( preg_match( $unicodeBlacklist, $name ) ) {
991 * Usernames which fail to pass this function will be blocked
992 * from user login and new account registrations, but may be used
993 * internally by batch processes.
995 * If an account already exists in this form, login will be blocked
996 * by a failure to pass this function.
998 * @param string $name Name to match
1001 public static function isUsableName( $name ) {
1002 global $wgReservedUsernames;
1003 // Must be a valid username, obviously ;)
1004 if ( !self
::isValidUserName( $name ) ) {
1008 static $reservedUsernames = false;
1009 if ( !$reservedUsernames ) {
1010 $reservedUsernames = $wgReservedUsernames;
1011 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
1014 // Certain names may be reserved for batch processes.
1015 foreach ( $reservedUsernames as $reserved ) {
1016 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
1017 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->plain();
1019 if ( $reserved == $name ) {
1027 * Return the users who are members of the given group(s). In case of multiple groups,
1028 * users who are members of at least one of them are returned.
1030 * @param string|array $groups A single group name or an array of group names
1031 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
1032 * records; larger values are ignored.
1033 * @param int|null $after ID the user to start after
1034 * @return UserArrayFromResult
1036 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
1037 if ( $groups === [] ) {
1038 return UserArrayFromResult
::newFromIDs( [] );
1041 $groups = array_unique( (array)$groups );
1042 $limit = min( 5000, $limit );
1044 $conds = [ 'ug_group' => $groups ];
1045 if ( $after !== null ) {
1046 $conds[] = 'ug_user > ' . (int)$after;
1049 $dbr = wfGetDB( DB_REPLICA
);
1050 $ids = $dbr->selectFieldValues(
1057 'ORDER BY' => 'ug_user',
1061 return UserArray
::newFromIDs( $ids );
1065 * Usernames which fail to pass this function will be blocked
1066 * from new account registrations, but may be used internally
1067 * either by batch processes or by user accounts which have
1068 * already been created.
1070 * Additional blacklisting may be added here rather than in
1071 * isValidUserName() to avoid disrupting existing accounts.
1073 * @param string $name String to match
1076 public static function isCreatableName( $name ) {
1077 global $wgInvalidUsernameCharacters;
1079 // Ensure that the username isn't longer than 235 bytes, so that
1080 // (at least for the builtin skins) user javascript and css files
1081 // will work. (T25080)
1082 if ( strlen( $name ) > 235 ) {
1083 wfDebugLog( 'username', __METHOD__
.
1084 ": '$name' invalid due to length" );
1088 // Preg yells if you try to give it an empty string
1089 if ( $wgInvalidUsernameCharacters !== '' &&
1090 preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name )
1092 wfDebugLog( 'username', __METHOD__
.
1093 ": '$name' invalid due to wgInvalidUsernameCharacters" );
1097 return self
::isUsableName( $name );
1101 * Is the input a valid password for this user?
1103 * @param string $password Desired password
1106 public function isValidPassword( $password ) {
1107 // simple boolean wrapper for checkPasswordValidity
1108 return $this->checkPasswordValidity( $password )->isGood();
1112 * Check if this is a valid password for this user
1114 * Returns a Status object with a set of messages describing
1115 * problems with the password. If the return status is fatal,
1116 * the action should be refused and the password should not be
1117 * checked at all (this is mainly meant for DoS mitigation).
1118 * If the return value is OK but not good, the password can be checked,
1119 * but the user should not be able to set their password to this.
1120 * The value of the returned Status object will be an array which
1121 * can have the following fields:
1122 * - forceChange (bool): if set to true, the user should not be
1123 * allowed to log with this password unless they change it during
1124 * the login process (see ResetPasswordSecondaryAuthenticationProvider).
1125 * - suggestChangeOnLogin (bool): if set to true, the user should be prompted for
1126 * a password change on login.
1128 * @param string $password Desired password
1132 public function checkPasswordValidity( $password ) {
1133 global $wgPasswordPolicy;
1135 $upp = new UserPasswordPolicy(
1136 $wgPasswordPolicy['policies'],
1137 $wgPasswordPolicy['checks']
1140 $status = Status
::newGood( [] );
1141 $result = false; // init $result to false for the internal checks
1143 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1144 $status->error( $result );
1148 if ( $result === false ) {
1149 $status->merge( $upp->checkUserPassword( $this, $password ), true );
1153 if ( $result === true ) {
1157 $status->error( $result );
1158 return $status; // the isValidPassword hook set a string $result and returned true
1162 * Given unvalidated user input, return a canonical username, or false if
1163 * the username is invalid.
1164 * @param string $name User input
1165 * @param string|bool $validate Type of validation to use:
1166 * - false No validation
1167 * - 'valid' Valid for batch processes
1168 * - 'usable' Valid for batch processes and login
1169 * - 'creatable' Valid for batch processes, login and account creation
1171 * @throws InvalidArgumentException
1172 * @return bool|string
1174 public static function getCanonicalName( $name, $validate = 'valid' ) {
1175 // Force usernames to capital
1176 $name = MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name );
1178 # Reject names containing '#'; these will be cleaned up
1179 # with title normalisation, but then it's too late to
1181 if ( strpos( $name, '#' ) !== false ) {
1185 // Clean up name according to title rules,
1186 // but only when validation is requested (T14654)
1187 $t = ( $validate !== false ) ?
1188 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1189 // Check for invalid titles
1190 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1194 $name = $t->getText();
1196 switch ( $validate ) {
1200 if ( !self
::isValidUserName( $name ) ) {
1205 if ( !self
::isUsableName( $name ) ) {
1210 if ( !self
::isCreatableName( $name ) ) {
1215 throw new InvalidArgumentException(
1216 'Invalid parameter value for $validate in ' . __METHOD__
);
1222 * Set cached properties to default.
1224 * @note This no longer clears uncached lazy-initialised properties;
1225 * the constructor does that instead.
1227 * @param string|bool $name
1229 public function loadDefaults( $name = false ) {
1231 $this->mName
= $name;
1232 $this->mActorId
= null;
1233 $this->mRealName
= '';
1235 $this->mOptionOverrides
= null;
1236 $this->mOptionsLoaded
= false;
1238 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1239 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1240 if ( $loggedOut !== 0 ) {
1241 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1243 $this->mTouched
= '1'; # Allow any pages to be cached
1246 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1247 $this->mEmailAuthenticated
= null;
1248 $this->mEmailToken
= '';
1249 $this->mEmailTokenExpires
= null;
1250 $this->mRegistration
= wfTimestamp( TS_MW
);
1251 $this->mGroupMemberships
= [];
1253 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1257 * Return whether an item has been loaded.
1259 * @param string $item Item to check. Current possibilities:
1263 * @param string $all 'all' to check if the whole object has been loaded
1264 * or any other string to check if only the item is available (e.g.
1268 public function isItemLoaded( $item, $all = 'all' ) {
1269 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1270 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1274 * Set that an item has been loaded
1276 * @param string $item
1278 protected function setItemLoaded( $item ) {
1279 if ( is_array( $this->mLoadedItems
) ) {
1280 $this->mLoadedItems
[$item] = true;
1285 * Load user data from the session.
1287 * @return bool True if the user is logged in, false otherwise.
1289 private function loadFromSession() {
1290 // MediaWiki\Session\Session already did the necessary authentication of the user
1291 // returned here, so just use it if applicable.
1292 $session = $this->getRequest()->getSession();
1293 $user = $session->getUser();
1294 if ( $user->isLoggedIn() ) {
1295 $this->loadFromUserObject( $user );
1297 // If this user is autoblocked, set a cookie to track the block. This has to be done on
1298 // every session load, because an autoblocked editor might not edit again from the same
1299 // IP address after being blocked.
1300 MediaWikiServices
::getInstance()->getBlockManager()->trackBlockWithCookie( $this );
1302 // Other code expects these to be set in the session, so set them.
1303 $session->set( 'wsUserID', $this->getId() );
1304 $session->set( 'wsUserName', $this->getName() );
1305 $session->set( 'wsToken', $this->getToken() );
1314 * Set the 'BlockID' cookie depending on block type and user authentication status.
1316 * @deprecated since 1.34 Use BlockManager::trackBlockWithCookie instead
1318 public function trackBlockWithCookie() {
1319 MediaWikiServices
::getInstance()->getBlockManager()->trackBlockWithCookie( $this );
1323 * Load user and user_group data from the database.
1324 * $this->mId must be set, this is how the user is identified.
1326 * @param int $flags User::READ_* constant bitfield
1327 * @return bool True if the user exists, false if the user is anonymous
1329 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1331 $this->mId
= intval( $this->mId
);
1333 if ( !$this->mId
) {
1334 // Anonymous users are not in the database
1335 $this->loadDefaults();
1339 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1340 $db = wfGetDB( $index );
1342 $userQuery = self
::getQueryInfo();
1343 $s = $db->selectRow(
1344 $userQuery['tables'],
1345 $userQuery['fields'],
1346 [ 'user_id' => $this->mId
],
1352 $this->queryFlagsUsed
= $flags;
1353 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1355 if ( $s !== false ) {
1356 // Initialise user table data
1357 $this->loadFromRow( $s );
1358 $this->mGroupMemberships
= null; // deferred
1359 $this->getEditCount(); // revalidation for nulls
1365 $this->loadDefaults();
1371 * Initialize this object from a row from the user table.
1373 * @param stdClass $row Row from the user table to load.
1374 * @param array|null $data Further user data to load into the object
1376 * user_groups Array of arrays or stdClass result rows out of the user_groups
1377 * table. Previously you were supposed to pass an array of strings
1378 * here, but we also need expiry info nowadays, so an array of
1379 * strings is ignored.
1380 * user_properties Array with properties out of the user_properties table
1382 protected function loadFromRow( $row, $data = null ) {
1383 global $wgActorTableSchemaMigrationStage;
1385 if ( !is_object( $row ) ) {
1386 throw new InvalidArgumentException( '$row must be an object' );
1391 $this->mGroupMemberships
= null; // deferred
1393 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
1394 // but it does little harm and might be needed for write callers loading a User.
1395 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
1396 if ( isset( $row->actor_id
) ) {
1397 $this->mActorId
= (int)$row->actor_id
;
1398 if ( $this->mActorId
!== 0 ) {
1399 $this->mFrom
= 'actor';
1401 $this->setItemLoaded( 'actor' );
1407 if ( isset( $row->user_name
) && $row->user_name
!== '' ) {
1408 $this->mName
= $row->user_name
;
1409 $this->mFrom
= 'name';
1410 $this->setItemLoaded( 'name' );
1415 if ( isset( $row->user_real_name
) ) {
1416 $this->mRealName
= $row->user_real_name
;
1417 $this->setItemLoaded( 'realname' );
1422 if ( isset( $row->user_id
) ) {
1423 $this->mId
= intval( $row->user_id
);
1424 if ( $this->mId
!== 0 ) {
1425 $this->mFrom
= 'id';
1427 $this->setItemLoaded( 'id' );
1432 if ( isset( $row->user_id
) && isset( $row->user_name
) && $row->user_name
!== '' ) {
1433 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1436 if ( isset( $row->user_editcount
) ) {
1437 $this->mEditCount
= $row->user_editcount
;
1442 if ( isset( $row->user_touched
) ) {
1443 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1448 if ( isset( $row->user_token
) ) {
1449 // The definition for the column is binary(32), so trim the NULs
1450 // that appends. The previous definition was char(32), so trim
1452 $this->mToken
= rtrim( $row->user_token
, " \0" );
1453 if ( $this->mToken
=== '' ) {
1454 $this->mToken
= null;
1460 if ( isset( $row->user_email
) ) {
1461 $this->mEmail
= $row->user_email
;
1462 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1463 $this->mEmailToken
= $row->user_email_token
;
1464 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1465 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1471 $this->mLoadedItems
= true;
1474 if ( is_array( $data ) ) {
1475 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1476 if ( $data['user_groups'] === [] ) {
1477 $this->mGroupMemberships
= [];
1479 $firstGroup = reset( $data['user_groups'] );
1480 if ( is_array( $firstGroup ) ||
is_object( $firstGroup ) ) {
1481 $this->mGroupMemberships
= [];
1482 foreach ( $data['user_groups'] as $row ) {
1483 $ugm = UserGroupMembership
::newFromRow( (object)$row );
1484 $this->mGroupMemberships
[$ugm->getGroup()] = $ugm;
1489 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1490 $this->loadOptions( $data['user_properties'] );
1496 * Load the data for this user object from another user object.
1500 protected function loadFromUserObject( $user ) {
1502 foreach ( self
::$mCacheVars as $var ) {
1503 $this->$var = $user->$var;
1508 * Load the groups from the database if they aren't already loaded.
1510 private function loadGroups() {
1511 if ( is_null( $this->mGroupMemberships
) ) {
1512 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1513 ?
wfGetDB( DB_MASTER
)
1514 : wfGetDB( DB_REPLICA
);
1515 $this->mGroupMemberships
= UserGroupMembership
::getMembershipsForUser(
1521 * Add the user to the group if he/she meets given criteria.
1523 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1524 * possible to remove manually via Special:UserRights. In such case it
1525 * will not be re-added automatically. The user will also not lose the
1526 * group if they no longer meet the criteria.
1528 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1530 * @return array Array of groups the user has been promoted to.
1532 * @see $wgAutopromoteOnce
1534 public function addAutopromoteOnceGroups( $event ) {
1535 global $wgAutopromoteOnceLogInRC;
1537 if ( wfReadOnly() ||
!$this->getId() ) {
1541 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1542 if ( $toPromote === [] ) {
1546 if ( !$this->checkAndSetTouched() ) {
1547 return []; // raced out (bug T48834)
1550 $oldGroups = $this->getGroups(); // previous groups
1551 $oldUGMs = $this->getGroupMemberships();
1552 foreach ( $toPromote as $group ) {
1553 $this->addGroup( $group );
1555 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1556 $newUGMs = $this->getGroupMemberships();
1558 // update groups in external authentication database
1559 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );
1561 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1562 $logEntry->setPerformer( $this );
1563 $logEntry->setTarget( $this->getUserPage() );
1564 $logEntry->setParameters( [
1565 '4::oldgroups' => $oldGroups,
1566 '5::newgroups' => $newGroups,
1568 $logid = $logEntry->insert();
1569 if ( $wgAutopromoteOnceLogInRC ) {
1570 $logEntry->publish( $logid );
1577 * Builds update conditions. Additional conditions may be added to $conditions to
1578 * protected against race conditions using a compare-and-set (CAS) mechanism
1579 * based on comparing $this->mTouched with the user_touched field.
1581 * @param IDatabase $db
1582 * @param array $conditions WHERE conditions for use with Database::update
1583 * @return array WHERE conditions for use with Database::update
1585 protected function makeUpdateConditions( IDatabase
$db, array $conditions ) {
1586 if ( $this->mTouched
) {
1587 // CAS check: only update if the row wasn't changed sicne it was loaded.
1588 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1595 * Bump user_touched if it didn't change since this object was loaded
1597 * On success, the mTouched field is updated.
1598 * The user serialization cache is always cleared.
1600 * @return bool Whether user_touched was actually updated
1603 protected function checkAndSetTouched() {
1606 if ( !$this->mId
) {
1607 return false; // anon
1610 // Get a new user_touched that is higher than the old one
1611 $newTouched = $this->newTouchedTimestamp();
1613 $dbw = wfGetDB( DB_MASTER
);
1614 $dbw->update( 'user',
1615 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1616 $this->makeUpdateConditions( $dbw, [
1617 'user_id' => $this->mId
,
1621 $success = ( $dbw->affectedRows() > 0 );
1624 $this->mTouched
= $newTouched;
1625 $this->clearSharedCache( 'changed' );
1627 // Clears on failure too since that is desired if the cache is stale
1628 $this->clearSharedCache( 'refresh' );
1635 * Clear various cached data stored in this object. The cache of the user table
1636 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1638 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1639 * given source. May be "name", "id", "actor", "defaults", "session", or false for no reload.
1641 public function clearInstanceCache( $reloadFrom = false ) {
1642 global $wgFullyInitialised;
1644 $this->mNewtalk
= -1;
1645 $this->mDatePreference
= null;
1646 $this->mBlockedby
= -1; # Unset
1647 $this->mHash
= false;
1648 $this->mEffectiveGroups
= null;
1649 $this->mImplicitGroups
= null;
1650 $this->mGroupMemberships
= null;
1651 $this->mOptions
= null;
1652 $this->mOptionsLoaded
= false;
1653 $this->mEditCount
= null;
1655 // Replacement of former `$this->mRights = null` line
1656 if ( $wgFullyInitialised && $this->mFrom
) {
1657 MediaWikiServices
::getInstance()->getPermissionManager()->invalidateUsersRightsCache(
1662 if ( $reloadFrom ) {
1663 $this->mLoadedItems
= [];
1664 $this->mFrom
= $reloadFrom;
1668 /** @var array|null */
1669 private static $defOpt = null;
1670 /** @var string|null */
1671 private static $defOptLang = null;
1674 * Reset the process cache of default user options. This is only necessary
1675 * if the wiki configuration has changed since defaults were calculated,
1676 * and as such should only be performed inside the testing suite that
1677 * regularly changes wiki configuration.
1679 public static function resetGetDefaultOptionsForTestsOnly() {
1680 Assert
::invariant( defined( 'MW_PHPUNIT_TEST' ), 'Unit tests only' );
1681 self
::$defOpt = null;
1682 self
::$defOptLang = null;
1686 * Combine the language default options with any site-specific options
1687 * and add the default language variants.
1689 * @return array Array of String options
1691 public static function getDefaultOptions() {
1692 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgDefaultSkin;
1694 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
1695 if ( self
::$defOpt !== null && self
::$defOptLang === $contLang->getCode() ) {
1696 // The content language does not change (and should not change) mid-request, but the
1697 // unit tests change it anyway, and expect this method to return values relevant to the
1698 // current content language.
1699 return self
::$defOpt;
1702 self
::$defOpt = $wgDefaultUserOptions;
1703 // Default language setting
1704 self
::$defOptLang = $contLang->getCode();
1705 self
::$defOpt['language'] = self
::$defOptLang;
1706 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1707 if ( $langCode === $contLang->getCode() ) {
1708 self
::$defOpt['variant'] = $langCode;
1710 self
::$defOpt["variant-$langCode"] = $langCode;
1714 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1715 // since extensions may change the set of searchable namespaces depending
1716 // on user groups/permissions.
1717 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1718 self
::$defOpt['searchNs' . $nsnum] = (bool)$val;
1720 self
::$defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1722 Hooks
::run( 'UserGetDefaultOptions', [ &self
::$defOpt ] );
1724 return self
::$defOpt;
1728 * Get a given default option value.
1730 * @param string $opt Name of option to retrieve
1731 * @return string Default option value
1733 public static function getDefaultOption( $opt ) {
1734 $defOpts = self
::getDefaultOptions();
1735 return $defOpts[$opt] ??
null;
1739 * Get blocking information
1741 * TODO: Move this into the BlockManager, along with block-related properties.
1743 * @param bool $fromReplica Whether to check the replica DB first.
1744 * To improve performance, non-critical checks are done against replica DBs.
1745 * Check when actually saving should be done against master.
1747 private function getBlockedStatus( $fromReplica = true ) {
1748 if ( $this->mBlockedby
!= -1 ) {
1752 wfDebug( __METHOD__
. ": checking...\n" );
1754 // Initialize data...
1755 // Otherwise something ends up stomping on $this->mBlockedby when
1756 // things get lazy-loaded later, causing false positive block hits
1757 // due to -1 !== 0. Probably session-related... Nothing should be
1758 // overwriting mBlockedby, surely?
1761 $block = MediaWikiServices
::getInstance()->getBlockManager()->getUserBlock(
1767 $this->mBlock
= $block;
1768 $this->mBlockedby
= $block->getByName();
1769 $this->mBlockreason
= $block->getReason();
1770 $this->mHideName
= $block->getHideName();
1771 $this->mAllowUsertalk
= $block->isUsertalkEditAllowed();
1773 $this->mBlock
= null;
1774 $this->mBlockedby
= '';
1775 $this->mBlockreason
= '';
1776 $this->mHideName
= 0;
1777 $this->mAllowUsertalk
= false;
1780 // Avoid PHP 7.1 warning of passing $this by reference
1783 Hooks
::run( 'GetBlockedStatus', [ &$thisUser ] );
1787 * Whether the given IP is in a DNS blacklist.
1789 * @deprecated since 1.34 Use BlockManager::isDnsBlacklisted.
1790 * @param string $ip IP to check
1791 * @param bool $checkWhitelist Whether to check the whitelist first
1792 * @return bool True if blacklisted.
1794 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1795 return MediaWikiServices
::getInstance()->getBlockManager()
1796 ->isDnsBlacklisted( $ip, $checkWhitelist );
1800 * Whether the given IP is in a given DNS blacklist.
1802 * @deprecated since 1.34 Check via BlockManager::isDnsBlacklisted instead.
1803 * @param string $ip IP to check
1804 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1805 * @return bool True if blacklisted.
1807 public function inDnsBlacklist( $ip, $bases ) {
1808 wfDeprecated( __METHOD__
, '1.34' );
1811 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
1812 if ( IP
::isIPv4( $ip ) ) {
1813 // Reverse IP, T23255
1814 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1816 foreach ( (array)$bases as $base ) {
1818 // If we have an access key, use that too (ProjectHoneypot, etc.)
1820 if ( is_array( $base ) ) {
1821 if ( count( $base ) >= 2 ) {
1822 // Access key is 1, base URL is 0
1823 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1825 $host = "$ipReversed.{$base[0]}";
1827 $basename = $base[0];
1829 $host = "$ipReversed.$base";
1833 $ipList = gethostbynamel( $host );
1836 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
1841 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
1849 * Check if an IP address is in the local proxy list
1851 * @deprecated since 1.34 Use BlockManager::getUserBlock instead.
1855 public static function isLocallyBlockedProxy( $ip ) {
1856 wfDeprecated( __METHOD__
, '1.34' );
1858 global $wgProxyList;
1860 if ( !$wgProxyList ) {
1864 if ( !is_array( $wgProxyList ) ) {
1865 // Load values from the specified file
1866 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1869 $resultProxyList = [];
1870 $deprecatedIPEntries = [];
1872 // backward compatibility: move all ip addresses in keys to values
1873 foreach ( $wgProxyList as $key => $value ) {
1874 $keyIsIP = IP
::isIPAddress( $key );
1875 $valueIsIP = IP
::isIPAddress( $value );
1876 if ( $keyIsIP && !$valueIsIP ) {
1877 $deprecatedIPEntries[] = $key;
1878 $resultProxyList[] = $key;
1879 } elseif ( $keyIsIP && $valueIsIP ) {
1880 $deprecatedIPEntries[] = $key;
1881 $resultProxyList[] = $key;
1882 $resultProxyList[] = $value;
1884 $resultProxyList[] = $value;
1888 if ( $deprecatedIPEntries ) {
1890 'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
1891 implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
1894 $proxyListIPSet = new IPSet( $resultProxyList );
1895 return $proxyListIPSet->match( $ip );
1899 * Is this user subject to rate limiting?
1901 * @return bool True if rate limited
1903 public function isPingLimitable() {
1904 global $wgRateLimitsExcludedIPs;
1905 if ( IP
::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1906 // No other good way currently to disable rate limits
1907 // for specific IPs. :P
1908 // But this is a crappy hack and should die.
1911 return !$this->isAllowed( 'noratelimit' );
1915 * Primitive rate limits: enforce maximum actions per time period
1916 * to put a brake on flooding.
1918 * The method generates both a generic profiling point and a per action one
1919 * (suffix being "-$action".
1921 * @note When using a shared cache like memcached, IP-address
1922 * last-hit counters will be shared across wikis.
1924 * @param string $action Action to enforce; 'edit' if unspecified
1925 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1926 * @return bool True if a rate limiter was tripped
1928 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1929 // Avoid PHP 7.1 warning of passing $this by reference
1931 // Call the 'PingLimiter' hook
1933 if ( !Hooks
::run( 'PingLimiter', [ &$user, $action, &$result, $incrBy ] ) ) {
1937 global $wgRateLimits;
1938 if ( !isset( $wgRateLimits[$action] ) ) {
1942 $limits = array_merge(
1943 [ '&can-bypass' => true ],
1944 $wgRateLimits[$action]
1947 // Some groups shouldn't trigger the ping limiter, ever
1948 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
1953 $id = $this->getId();
1955 $isNewbie = $this->isNewbie();
1956 $cache = ObjectCache
::getLocalClusterInstance();
1960 if ( isset( $limits['anon'] ) ) {
1961 $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1963 } elseif ( isset( $limits['user'] ) ) {
1964 // limits for logged-in users
1965 $userLimit = $limits['user'];
1968 // limits for anons and for newbie logged-in users
1971 if ( isset( $limits['ip'] ) ) {
1972 $ip = $this->getRequest()->getIP();
1973 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1975 // subnet-based limits
1976 if ( isset( $limits['subnet'] ) ) {
1977 $ip = $this->getRequest()->getIP();
1978 $subnet = IP
::getSubnet( $ip );
1979 if ( $subnet !== false ) {
1980 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1985 // Check for group-specific permissions
1986 // If more than one group applies, use the group with the highest limit ratio (max/period)
1987 foreach ( $this->getGroups() as $group ) {
1988 if ( isset( $limits[$group] ) ) {
1989 if ( $userLimit === false
1990 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
1992 $userLimit = $limits[$group];
1997 // limits for newbie logged-in users (override all the normal user limits)
1998 if ( $id !== 0 && $isNewbie && isset( $limits['newbie'] ) ) {
1999 $userLimit = $limits['newbie'];
2002 // Set the user limit key
2003 if ( $userLimit !== false ) {
2004 // phan is confused because &can-bypass's value is a bool, so it assumes
2005 // that $userLimit is also a bool here.
2006 // @phan-suppress-next-line PhanTypeInvalidExpressionArrayDestructuring
2007 list( $max, $period ) = $userLimit;
2008 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
2009 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
2012 // ip-based limits for all ping-limitable users
2013 if ( isset( $limits['ip-all'] ) ) {
2014 $ip = $this->getRequest()->getIP();
2015 // ignore if user limit is more permissive
2016 if ( $isNewbie ||
$userLimit === false
2017 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
2018 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
2022 // subnet-based limits for all ping-limitable users
2023 if ( isset( $limits['subnet-all'] ) ) {
2024 $ip = $this->getRequest()->getIP();
2025 $subnet = IP
::getSubnet( $ip );
2026 if ( $subnet !== false ) {
2027 // ignore if user limit is more permissive
2028 if ( $isNewbie ||
$userLimit === false
2029 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
2030 > $userLimit[0] / $userLimit[1] ) {
2031 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
2037 foreach ( $keys as $key => $limit ) {
2038 // phan is confused because &can-bypass's value is a bool, so it assumes
2039 // that $userLimit is also a bool here.
2040 // @phan-suppress-next-line PhanTypeInvalidExpressionArrayDestructuring
2041 list( $max, $period ) = $limit;
2042 $summary = "(limit $max in {$period}s)";
2043 $count = $cache->get( $key );
2045 if ( $count && $count >= $max ) {
2046 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
2047 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
2050 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
2051 if ( $incrBy > 0 ) {
2052 $cache->add( $key, 0, intval( $period ) ); // first ping
2055 if ( $incrBy > 0 ) {
2056 $cache->incrWithInit( $key, (int)$period, $incrBy, $incrBy );
2064 * Check if user is blocked
2066 * @deprecated since 1.34, use User::getBlock() or
2067 * PermissionManager::isBlockedFrom() or
2068 * PermissionManager::userCan() instead.
2070 * @param bool $fromReplica Whether to check the replica DB instead of
2071 * the master. Hacked from false due to horrible probs on site.
2072 * @return bool True if blocked, false otherwise
2074 public function isBlocked( $fromReplica = true ) {
2075 return $this->getBlock( $fromReplica ) instanceof AbstractBlock
&&
2076 $this->getBlock()->appliesToRight( 'edit' );
2080 * Get the block affecting the user, or null if the user is not blocked
2082 * @param bool $fromReplica Whether to check the replica DB instead of the master
2083 * @return AbstractBlock|null
2085 public function getBlock( $fromReplica = true ) {
2086 $this->getBlockedStatus( $fromReplica );
2087 return $this->mBlock
instanceof AbstractBlock ?
$this->mBlock
: null;
2091 * Check if user is blocked from editing a particular article
2093 * @param Title $title Title to check
2094 * @param bool $fromReplica Whether to check the replica DB instead of the master
2097 * @deprecated since 1.33,
2098 * use MediaWikiServices::getInstance()->getPermissionManager()->isBlockedFrom(..)
2101 public function isBlockedFrom( $title, $fromReplica = false ) {
2102 return MediaWikiServices
::getInstance()->getPermissionManager()
2103 ->isBlockedFrom( $this, $title, $fromReplica );
2107 * If user is blocked, return the name of the user who placed the block
2108 * @return string Name of blocker
2110 public function blockedBy() {
2111 $this->getBlockedStatus();
2112 return $this->mBlockedby
;
2116 * If user is blocked, return the specified reason for the block
2117 * @return string Blocking reason
2119 public function blockedFor() {
2120 $this->getBlockedStatus();
2121 return $this->mBlockreason
;
2125 * If user is blocked, return the ID for the block
2126 * @return int Block ID
2128 public function getBlockId() {
2129 $this->getBlockedStatus();
2130 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2134 * Check if user is blocked on all wikis.
2135 * Do not use for actual edit permission checks!
2136 * This is intended for quick UI checks.
2138 * @param string $ip IP address, uses current client if none given
2139 * @return bool True if blocked, false otherwise
2141 public function isBlockedGlobally( $ip = '' ) {
2142 return $this->getGlobalBlock( $ip ) instanceof AbstractBlock
;
2146 * Check if user is blocked on all wikis.
2147 * Do not use for actual edit permission checks!
2148 * This is intended for quick UI checks.
2150 * @param string $ip IP address, uses current client if none given
2151 * @return AbstractBlock|null Block object if blocked, null otherwise
2152 * @throws FatalError
2153 * @throws MWException
2155 public function getGlobalBlock( $ip = '' ) {
2156 if ( $this->mGlobalBlock
!== null ) {
2157 return $this->mGlobalBlock ?
: null;
2159 // User is already an IP?
2160 if ( IP
::isIPAddress( $this->getName() ) ) {
2161 $ip = $this->getName();
2163 $ip = $this->getRequest()->getIP();
2165 // Avoid PHP 7.1 warning of passing $this by reference
2169 Hooks
::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
2171 if ( $blocked && $block === null ) {
2172 // back-compat: UserIsBlockedGlobally didn't have $block param first
2173 $block = new SystemBlock( [
2175 'systemBlock' => 'global-block'
2179 $this->mGlobalBlock
= $blocked ?
$block : false;
2180 return $this->mGlobalBlock ?
: null;
2184 * Check if user account is locked
2186 * @return bool True if locked, false otherwise
2188 public function isLocked() {
2189 if ( $this->mLocked
!== null ) {
2190 return $this->mLocked
;
2193 $this->mLocked
= false;
2194 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2195 return $this->mLocked
;
2199 * Check if user account is hidden
2201 * @return bool True if hidden, false otherwise
2203 public function isHidden() {
2204 if ( $this->mHideName
!== null ) {
2205 return (bool)$this->mHideName
;
2207 $this->getBlockedStatus();
2208 if ( !$this->mHideName
) {
2210 $this->mHideName
= false;
2211 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2213 return (bool)$this->mHideName
;
2217 * Get the user's ID.
2218 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2220 public function getId() {
2221 if ( $this->mId
=== null && $this->mName
!== null && self
::isIP( $this->mName
) ) {
2222 // Special case, we know the user is anonymous
2226 if ( !$this->isItemLoaded( 'id' ) ) {
2227 // Don't load if this was initialized from an ID
2231 return (int)$this->mId
;
2235 * Set the user and reload all fields according to a given ID
2236 * @param int $v User ID to reload
2238 public function setId( $v ) {
2240 $this->clearInstanceCache( 'id' );
2244 * Get the user name, or the IP of an anonymous user
2245 * @return string User's name or IP address
2247 public function getName() {
2248 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2249 // Special case optimisation
2250 return $this->mName
;
2254 if ( $this->mName
=== false ) {
2256 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2259 return $this->mName
;
2263 * Set the user name.
2265 * This does not reload fields from the database according to the given
2266 * name. Rather, it is used to create a temporary "nonexistent user" for
2267 * later addition to the database. It can also be used to set the IP
2268 * address for an anonymous user to something other than the current
2271 * @note User::newFromName() has roughly the same function, when the named user
2273 * @param string $str New user name to set
2275 public function setName( $str ) {
2277 $this->mName
= $str;
2281 * Get the user's actor ID.
2283 * @param IDatabase|null $dbw Assign a new actor ID, using this DB handle, if none exists
2284 * @return int The actor's ID, or 0 if no actor ID exists and $dbw was null
2286 public function getActorId( IDatabase
$dbw = null ) {
2287 global $wgActorTableSchemaMigrationStage;
2289 // Technically we should always return 0 without SCHEMA_COMPAT_READ_NEW,
2290 // but it does little harm and might be needed for write callers loading a User.
2291 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) ) {
2295 if ( !$this->isItemLoaded( 'actor' ) ) {
2299 // Currently $this->mActorId might be null if $this was loaded from a
2300 // cache entry that was written when $wgActorTableSchemaMigrationStage
2301 // was SCHEMA_COMPAT_OLD. Once that is no longer a possibility (i.e. when
2302 // User::VERSION is incremented after $wgActorTableSchemaMigrationStage
2303 // has been removed), that condition may be removed.
2304 if ( $this->mActorId
=== null ||
!$this->mActorId
&& $dbw ) {
2306 'actor_user' => $this->getId() ?
: null,
2307 'actor_name' => (string)$this->getName(),
2310 if ( $q['actor_user'] === null && self
::isUsableName( $q['actor_name'] ) ) {
2311 throw new CannotCreateActorException(
2312 'Cannot create an actor for a usable name that is not an existing user'
2315 if ( $q['actor_name'] === '' ) {
2316 throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
2318 $dbw->insert( 'actor', $q, __METHOD__
, [ 'IGNORE' ] );
2319 if ( $dbw->affectedRows() ) {
2320 $this->mActorId
= (int)$dbw->insertId();
2323 // Use LOCK IN SHARE MODE to bypass any MySQL REPEATABLE-READ snapshot.
2324 $this->mActorId
= (int)$dbw->selectField(
2329 [ 'LOCK IN SHARE MODE' ]
2331 if ( !$this->mActorId
) {
2332 throw new CannotCreateActorException(
2333 "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
2337 $this->invalidateCache();
2339 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2340 $db = wfGetDB( $index );
2341 $this->mActorId
= (int)$db->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2343 $this->setItemLoaded( 'actor' );
2346 return (int)$this->mActorId
;
2350 * Get the user's name escaped by underscores.
2351 * @return string Username escaped by underscores.
2353 public function getTitleKey() {
2354 return str_replace( ' ', '_', $this->getName() );
2358 * Check if the user has new messages.
2359 * @return bool True if the user has new messages
2361 public function getNewtalk() {
2364 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2365 if ( $this->mNewtalk
=== -1 ) {
2366 $this->mNewtalk
= false; # reset talk page status
2368 // Check memcached separately for anons, who have no
2369 // entire User object stored in there.
2370 if ( !$this->mId
) {
2371 global $wgDisableAnonTalk;
2372 if ( $wgDisableAnonTalk ) {
2373 // Anon newtalk disabled by configuration.
2374 $this->mNewtalk
= false;
2376 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2379 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2383 return (bool)$this->mNewtalk
;
2387 * Return the data needed to construct links for new talk page message
2388 * alerts. If there are new messages, this will return an associative array
2389 * with the following data:
2390 * wiki: The database name of the wiki
2391 * link: Root-relative link to the user's talk page
2392 * rev: The last talk page revision that the user has seen or null. This
2393 * is useful for building diff links.
2394 * If there are no new messages, it returns an empty array.
2395 * @note This function was designed to accomodate multiple talk pages, but
2396 * currently only returns a single link and revision.
2399 public function getNewMessageLinks() {
2400 // Avoid PHP 7.1 warning of passing $this by reference
2403 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
2407 if ( !$this->getNewtalk() ) {
2410 $utp = $this->getTalkPage();
2411 $dbr = wfGetDB( DB_REPLICA
);
2412 // Get the "last viewed rev" timestamp from the oldest message notification
2413 $timestamp = $dbr->selectField( 'user_newtalk',
2414 'MIN(user_last_timestamp)',
2415 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2417 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2420 'wiki' => WikiMap
::getWikiIdFromDbDomain( WikiMap
::getCurrentWikiDbDomain() ),
2421 'link' => $utp->getLocalURL(),
2428 * Get the revision ID for the last talk page revision viewed by the talk
2430 * @return int|null Revision ID or null
2432 public function getNewMessageRevisionId() {
2433 $newMessageRevisionId = null;
2434 $newMessageLinks = $this->getNewMessageLinks();
2436 // Note: getNewMessageLinks() never returns more than a single link
2437 // and it is always for the same wiki, but we double-check here in
2438 // case that changes some time in the future.
2439 if ( $newMessageLinks && count( $newMessageLinks ) === 1
2440 && WikiMap
::isCurrentWikiId( $newMessageLinks[0]['wiki'] )
2441 && $newMessageLinks[0]['rev']
2443 /** @var Revision $newMessageRevision */
2444 $newMessageRevision = $newMessageLinks[0]['rev'];
2445 $newMessageRevisionId = $newMessageRevision->getId();
2448 return $newMessageRevisionId;
2452 * Internal uncached check for new messages
2455 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2456 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2457 * @return bool True if the user has new messages
2459 protected function checkNewtalk( $field, $id ) {
2460 $dbr = wfGetDB( DB_REPLICA
);
2462 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2464 return $ok !== false;
2468 * Add or update the new messages flag
2469 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2470 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2471 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2472 * @return bool True if successful, false otherwise
2474 protected function updateNewtalk( $field, $id, $curRev = null ) {
2475 // Get timestamp of the talk page revision prior to the current one
2476 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2477 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2478 // Mark the user as having new messages since this revision
2479 $dbw = wfGetDB( DB_MASTER
);
2480 $dbw->insert( 'user_newtalk',
2481 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2484 if ( $dbw->affectedRows() ) {
2485 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2489 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2494 * Clear the new messages flag for the given user
2495 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2496 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2497 * @return bool True if successful, false otherwise
2499 protected function deleteNewtalk( $field, $id ) {
2500 $dbw = wfGetDB( DB_MASTER
);
2501 $dbw->delete( 'user_newtalk',
2504 if ( $dbw->affectedRows() ) {
2505 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2509 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2514 * Update the 'You have new messages!' status.
2515 * @param bool $val Whether the user has new messages
2516 * @param Revision|null $curRev New, as yet unseen revision of the user talk
2517 * page. Ignored if null or !$val.
2519 public function setNewtalk( $val, $curRev = null ) {
2520 if ( wfReadOnly() ) {
2525 $this->mNewtalk
= $val;
2527 if ( $this->isAnon() ) {
2529 $id = $this->getName();
2532 $id = $this->getId();
2536 $changed = $this->updateNewtalk( $field, $id, $curRev );
2538 $changed = $this->deleteNewtalk( $field, $id );
2542 $this->invalidateCache();
2547 * Generate a current or new-future timestamp to be stored in the
2548 * user_touched field when we update things.
2550 * @return string Timestamp in TS_MW format
2552 private function newTouchedTimestamp() {
2554 if ( $this->mTouched
) {
2555 $time = max( $time, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2558 return wfTimestamp( TS_MW
, $time );
2562 * Clear user data from memcached
2564 * Use after applying updates to the database; caller's
2565 * responsibility to update user_touched if appropriate.
2567 * Called implicitly from invalidateCache() and saveSettings().
2569 * @param string $mode Use 'refresh' to clear now or 'changed' to clear before DB commit
2571 public function clearSharedCache( $mode = 'refresh' ) {
2572 if ( !$this->getId() ) {
2576 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2577 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2578 $key = $this->getCacheKey( $cache );
2580 if ( $mode === 'refresh' ) {
2581 $cache->delete( $key, 1 ); // low tombstone/"hold-off" TTL
2583 $lb->getConnectionRef( DB_MASTER
)->onTransactionPreCommitOrIdle(
2584 function () use ( $cache, $key ) {
2585 $cache->delete( $key );
2593 * Immediately touch the user data cache for this account
2595 * Calls touch() and removes account data from memcached
2597 public function invalidateCache() {
2599 $this->clearSharedCache( 'changed' );
2603 * Update the "touched" timestamp for the user
2605 * This is useful on various login/logout events when making sure that
2606 * a browser or proxy that has multiple tenants does not suffer cache
2607 * pollution where the new user sees the old users content. The value
2608 * of getTouched() is checked when determining 304 vs 200 responses.
2609 * Unlike invalidateCache(), this preserves the User object cache and
2610 * avoids database writes.
2614 public function touch() {
2615 $id = $this->getId();
2617 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2618 $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
2619 $cache->touchCheckKey( $key );
2620 $this->mQuickTouched
= null;
2625 * Validate the cache for this account.
2626 * @param string $timestamp A timestamp in TS_MW format
2629 public function validateCache( $timestamp ) {
2630 return ( $timestamp >= $this->getTouched() );
2634 * Get the user touched timestamp
2636 * Use this value only to validate caches via inequalities
2637 * such as in the case of HTTP If-Modified-Since response logic
2639 * @return string TS_MW Timestamp
2641 public function getTouched() {
2645 if ( $this->mQuickTouched
=== null ) {
2646 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2647 $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId
);
2649 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2652 return max( $this->mTouched
, $this->mQuickTouched
);
2655 return $this->mTouched
;
2659 * Get the user_touched timestamp field (time of last DB updates)
2660 * @return string TS_MW Timestamp
2663 public function getDBTouched() {
2666 return $this->mTouched
;
2670 * Set the password and reset the random token.
2671 * Calls through to authentication plugin if necessary;
2672 * will have no effect if the auth plugin refuses to
2673 * pass the change through or if the legal password
2676 * As a special case, setting the password to null
2677 * wipes it, so the account cannot be logged in until
2678 * a new password is set, for instance via e-mail.
2680 * @deprecated since 1.27, use AuthManager instead
2681 * @param string $str New password to set
2682 * @throws PasswordError On failure
2685 public function setPassword( $str ) {
2686 wfDeprecated( __METHOD__
, '1.27' );
2687 return $this->setPasswordInternal( $str );
2691 * Set the password and reset the random token unconditionally.
2693 * @deprecated since 1.27, use AuthManager instead
2694 * @param string|null $str New password to set or null to set an invalid
2695 * password hash meaning that the user will not be able to log in
2696 * through the web interface.
2698 public function setInternalPassword( $str ) {
2699 wfDeprecated( __METHOD__
, '1.27' );
2700 $this->setPasswordInternal( $str );
2704 * Actually set the password and such
2705 * @since 1.27 cannot set a password for a user not in the database
2706 * @param string|null $str New password to set or null to set an invalid
2707 * password hash meaning that the user will not be able to log in
2708 * through the web interface.
2709 * @return bool Success
2711 private function setPasswordInternal( $str ) {
2712 $manager = AuthManager
::singleton();
2714 // If the user doesn't exist yet, fail
2715 if ( !$manager->userExists( $this->getName() ) ) {
2716 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2719 $status = $this->changeAuthenticationData( [
2720 'username' => $this->getName(),
2724 if ( !$status->isGood() ) {
2725 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2726 ->info( __METHOD__
. ': Password change rejected: '
2727 . $status->getWikiText( null, null, 'en' ) );
2731 $this->setOption( 'watchlisttoken', false );
2732 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2738 * Changes credentials of the user.
2740 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2741 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2742 * e.g. when no provider handled the change.
2744 * @param array $data A set of authentication data in fieldname => value format. This is the
2745 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2749 public function changeAuthenticationData( array $data ) {
2750 $manager = AuthManager
::singleton();
2751 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2752 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2754 $status = Status
::newGood( 'ignored' );
2755 foreach ( $reqs as $req ) {
2756 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2758 if ( $status->getValue() === 'ignored' ) {
2759 $status->warning( 'authenticationdatachange-ignored' );
2762 if ( $status->isGood() ) {
2763 foreach ( $reqs as $req ) {
2764 $manager->changeAuthenticationData( $req );
2771 * Get the user's current token.
2772 * @param bool $forceCreation Force the generation of a new token if the
2773 * user doesn't have one (default=true for backwards compatibility).
2774 * @return string|null Token
2776 public function getToken( $forceCreation = true ) {
2777 global $wgAuthenticationTokenVersion;
2780 if ( !$this->mToken
&& $forceCreation ) {
2784 if ( !$this->mToken
) {
2785 // The user doesn't have a token, return null to indicate that.
2789 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
2790 // We return a random value here so existing token checks are very
2792 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2795 if ( $wgAuthenticationTokenVersion === null ) {
2796 // $wgAuthenticationTokenVersion not in use, so return the raw secret
2797 return $this->mToken
;
2800 // $wgAuthenticationTokenVersion in use, so hmac it.
2801 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
2803 // The raw hash can be overly long. Shorten it up.
2804 $len = max( 32, self
::TOKEN_LENGTH
);
2805 if ( strlen( $ret ) < $len ) {
2806 // Should never happen, even md5 is 128 bits
2807 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
2810 return substr( $ret, -$len );
2814 * Set the random token (used for persistent authentication)
2815 * Called from loadDefaults() among other places.
2817 * @param string|bool $token If specified, set the token to this value
2819 public function setToken( $token = false ) {
2821 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
2822 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
2823 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
2824 } elseif ( !$token ) {
2825 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2827 $this->mToken
= $token;
2832 * Set the password for a password reminder or new account email
2834 * @deprecated Removed in 1.27. Use PasswordReset instead.
2835 * @param string $str New password to set or null to set an invalid
2836 * password hash meaning that the user will not be able to use it
2837 * @param bool $throttle If true, reset the throttle timestamp to the present
2839 public function setNewpassword( $str, $throttle = true ) {
2840 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2844 * Get the user's e-mail address
2845 * @return string User's email address
2847 public function getEmail() {
2849 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
2850 return $this->mEmail
;
2854 * Get the timestamp of the user's e-mail authentication
2855 * @return string TS_MW timestamp
2857 public function getEmailAuthenticationTimestamp() {
2859 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
2860 return $this->mEmailAuthenticated
;
2864 * Set the user's e-mail address
2865 * @param string $str New e-mail address
2867 public function setEmail( $str ) {
2869 if ( $str == $this->mEmail
) {
2872 $this->invalidateEmail();
2873 $this->mEmail
= $str;
2874 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
2878 * Set the user's e-mail address and a confirmation mail if needed.
2881 * @param string $str New e-mail address
2884 public function setEmailWithConfirmation( $str ) {
2885 global $wgEnableEmail, $wgEmailAuthentication;
2887 if ( !$wgEnableEmail ) {
2888 return Status
::newFatal( 'emaildisabled' );
2891 $oldaddr = $this->getEmail();
2892 if ( $str === $oldaddr ) {
2893 return Status
::newGood( true );
2896 $type = $oldaddr != '' ?
'changed' : 'set';
2897 $notificationResult = null;
2899 if ( $wgEmailAuthentication && $type === 'changed' ) {
2900 // Send the user an email notifying the user of the change in registered
2901 // email address on their previous email address
2902 $change = $str != '' ?
'changed' : 'removed';
2903 $notificationResult = $this->sendMail(
2904 wfMessage( 'notificationemail_subject_' . $change )->text(),
2905 wfMessage( 'notificationemail_body_' . $change,
2906 $this->getRequest()->getIP(),
2912 $this->setEmail( $str );
2914 if ( $str !== '' && $wgEmailAuthentication ) {
2915 // Send a confirmation request to the new address if needed
2916 $result = $this->sendConfirmationMail( $type );
2918 if ( $notificationResult !== null ) {
2919 $result->merge( $notificationResult );
2922 if ( $result->isGood() ) {
2923 // Say to the caller that a confirmation and notification mail has been sent
2924 $result->value
= 'eauth';
2927 $result = Status
::newGood( true );
2934 * Get the user's real name
2935 * @return string User's real name
2937 public function getRealName() {
2938 if ( !$this->isItemLoaded( 'realname' ) ) {
2942 return $this->mRealName
;
2946 * Set the user's real name
2947 * @param string $str New real name
2949 public function setRealName( $str ) {
2951 $this->mRealName
= $str;
2955 * Get the user's current setting for a given option.
2957 * @param string $oname The option to check
2958 * @param string|array|null $defaultOverride A default value returned if the option does not exist
2959 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2960 * @return string|array|int|null User's current value for the option
2961 * @see getBoolOption()
2962 * @see getIntOption()
2964 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2965 global $wgHiddenPrefs;
2966 $this->loadOptions();
2968 # We want 'disabled' preferences to always behave as the default value for
2969 # users, even if they have set the option explicitly in their settings (ie they
2970 # set it, and then it was disabled removing their ability to change it). But
2971 # we don't want to erase the preferences in the database in case the preference
2972 # is re-enabled again. So don't touch $mOptions, just override the returned value
2973 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2974 return self
::getDefaultOption( $oname );
2977 if ( array_key_exists( $oname, $this->mOptions
) ) {
2978 return $this->mOptions
[$oname];
2981 return $defaultOverride;
2985 * Get all user's options
2987 * @param int $flags Bitwise combination of:
2988 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
2989 * to the default value. (Since 1.25)
2992 public function getOptions( $flags = 0 ) {
2993 global $wgHiddenPrefs;
2994 $this->loadOptions();
2995 $options = $this->mOptions
;
2997 # We want 'disabled' preferences to always behave as the default value for
2998 # users, even if they have set the option explicitly in their settings (ie they
2999 # set it, and then it was disabled removing their ability to change it). But
3000 # we don't want to erase the preferences in the database in case the preference
3001 # is re-enabled again. So don't touch $mOptions, just override the returned value
3002 foreach ( $wgHiddenPrefs as $pref ) {
3003 $default = self
::getDefaultOption( $pref );
3004 if ( $default !== null ) {
3005 $options[$pref] = $default;
3009 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
3010 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
3017 * Get the user's current setting for a given option, as a boolean value.
3019 * @param string $oname The option to check
3020 * @return bool User's current value for the option
3023 public function getBoolOption( $oname ) {
3024 return (bool)$this->getOption( $oname );
3028 * Get the user's current setting for a given option, as an integer value.
3030 * @param string $oname The option to check
3031 * @param int $defaultOverride A default value returned if the option does not exist
3032 * @return int User's current value for the option
3035 public function getIntOption( $oname, $defaultOverride = 0 ) {
3036 $val = $this->getOption( $oname );
3038 $val = $defaultOverride;
3040 return intval( $val );
3044 * Set the given option for a user.
3046 * You need to call saveSettings() to actually write to the database.
3048 * @param string $oname The option to set
3049 * @param mixed $val New value to set
3051 public function setOption( $oname, $val ) {
3052 $this->loadOptions();
3054 // Explicitly NULL values should refer to defaults
3055 if ( is_null( $val ) ) {
3056 $val = self
::getDefaultOption( $oname );
3059 $this->mOptions
[$oname] = $val;
3063 * Get a token stored in the preferences (like the watchlist one),
3064 * resetting it if it's empty (and saving changes).
3066 * @param string $oname The option name to retrieve the token from
3067 * @return string|bool User's current value for the option, or false if this option is disabled.
3068 * @see resetTokenFromOption()
3070 * @deprecated since 1.26 Applications should use the OAuth extension
3072 public function getTokenFromOption( $oname ) {
3073 global $wgHiddenPrefs;
3075 $id = $this->getId();
3076 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
3080 $token = $this->getOption( $oname );
3082 // Default to a value based on the user token to avoid space
3083 // wasted on storing tokens for all users. When this option
3084 // is set manually by the user, only then is it stored.
3085 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
3092 * Reset a token stored in the preferences (like the watchlist one).
3093 * *Does not* save user's preferences (similarly to setOption()).
3095 * @param string $oname The option name to reset the token in
3096 * @return string|bool New token value, or false if this option is disabled.
3097 * @see getTokenFromOption()
3100 public function resetTokenFromOption( $oname ) {
3101 global $wgHiddenPrefs;
3102 if ( in_array( $oname, $wgHiddenPrefs ) ) {
3106 $token = MWCryptRand
::generateHex( 40 );
3107 $this->setOption( $oname, $token );
3112 * Return a list of the types of user options currently returned by
3113 * User::getOptionKinds().
3115 * Currently, the option kinds are:
3116 * - 'registered' - preferences which are registered in core MediaWiki or
3117 * by extensions using the UserGetDefaultOptions hook.
3118 * - 'registered-multiselect' - as above, using the 'multiselect' type.
3119 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
3120 * - 'userjs' - preferences with names starting with 'userjs-', intended to
3121 * be used by user scripts.
3122 * - 'special' - "preferences" that are not accessible via User::getOptions
3123 * or User::setOptions.
3124 * - 'unused' - preferences about which MediaWiki doesn't know anything.
3125 * These are usually legacy options, removed in newer versions.
3127 * The API (and possibly others) use this function to determine the possible
3128 * option types for validation purposes, so make sure to update this when a
3129 * new option kind is added.
3131 * @see User::getOptionKinds
3132 * @return array Option kinds
3134 public static function listOptionKinds() {
3137 'registered-multiselect',
3138 'registered-checkmatrix',
3146 * Return an associative array mapping preferences keys to the kind of a preference they're
3147 * used for. Different kinds are handled differently when setting or reading preferences.
3149 * See User::listOptionKinds for the list of valid option types that can be provided.
3151 * @see User::listOptionKinds
3152 * @param IContextSource $context
3153 * @param array|null $options Assoc. array with options keys to check as keys.
3154 * Defaults to $this->mOptions.
3155 * @return array The key => kind mapping data
3157 public function getOptionKinds( IContextSource
$context, $options = null ) {
3158 $this->loadOptions();
3159 if ( $options === null ) {
3160 $options = $this->mOptions
;
3163 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
3164 $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
3167 // Pull out the "special" options, so they don't get converted as
3168 // multiselect or checkmatrix.
3169 $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
3170 foreach ( $specialOptions as $name => $value ) {
3171 unset( $prefs[$name] );
3174 // Multiselect and checkmatrix options are stored in the database with
3175 // one key per option, each having a boolean value. Extract those keys.
3176 $multiselectOptions = [];
3177 foreach ( $prefs as $name => $info ) {
3178 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3179 ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField
::class ) ) {
3180 $opts = HTMLFormField
::flattenOptions( $info['options'] );
3181 $prefix = $info['prefix'] ??
$name;
3183 foreach ( $opts as $value ) {
3184 $multiselectOptions["$prefix$value"] = true;
3187 unset( $prefs[$name] );
3190 $checkmatrixOptions = [];
3191 foreach ( $prefs as $name => $info ) {
3192 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3193 ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix
::class ) ) {
3194 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3195 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3196 $prefix = $info['prefix'] ??
$name;
3198 foreach ( $columns as $column ) {
3199 foreach ( $rows as $row ) {
3200 $checkmatrixOptions["$prefix$column-$row"] = true;
3204 unset( $prefs[$name] );
3208 // $value is ignored
3209 foreach ( $options as $key => $value ) {
3210 if ( isset( $prefs[$key] ) ) {
3211 $mapping[$key] = 'registered';
3212 } elseif ( isset( $multiselectOptions[$key] ) ) {
3213 $mapping[$key] = 'registered-multiselect';
3214 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3215 $mapping[$key] = 'registered-checkmatrix';
3216 } elseif ( isset( $specialOptions[$key] ) ) {
3217 $mapping[$key] = 'special';
3218 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3219 $mapping[$key] = 'userjs';
3221 $mapping[$key] = 'unused';
3229 * Reset certain (or all) options to the site defaults
3231 * The optional parameter determines which kinds of preferences will be reset.
3232 * Supported values are everything that can be reported by getOptionKinds()
3233 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3235 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3236 * [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ]
3237 * for backwards-compatibility.
3238 * @param IContextSource|null $context Context source used when $resetKinds
3239 * does not contain 'all', passed to getOptionKinds().
3240 * Defaults to RequestContext::getMain() when null.
3242 public function resetOptions(
3243 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3244 IContextSource
$context = null
3247 $defaultOptions = self
::getDefaultOptions();
3249 if ( !is_array( $resetKinds ) ) {
3250 $resetKinds = [ $resetKinds ];
3253 if ( in_array( 'all', $resetKinds ) ) {
3254 $newOptions = $defaultOptions;
3256 if ( $context === null ) {
3257 $context = RequestContext
::getMain();
3260 $optionKinds = $this->getOptionKinds( $context );
3261 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3264 // Use default values for the options that should be deleted, and
3265 // copy old values for the ones that shouldn't.
3266 foreach ( $this->mOptions
as $key => $value ) {
3267 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3268 if ( array_key_exists( $key, $defaultOptions ) ) {
3269 $newOptions[$key] = $defaultOptions[$key];
3272 $newOptions[$key] = $value;
3277 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3279 $this->mOptions
= $newOptions;
3280 $this->mOptionsLoaded
= true;
3284 * Get the user's preferred date format.
3285 * @return string User's preferred date format
3287 public function getDatePreference() {
3288 // Important migration for old data rows
3289 if ( is_null( $this->mDatePreference
) ) {
3291 $value = $this->getOption( 'date' );
3292 $map = $wgLang->getDatePreferenceMigrationMap();
3293 if ( isset( $map[$value] ) ) {
3294 $value = $map[$value];
3296 $this->mDatePreference
= $value;
3298 return $this->mDatePreference
;
3302 * Determine based on the wiki configuration and the user's options,
3303 * whether this user must be over HTTPS no matter what.
3307 public function requiresHTTPS() {
3308 global $wgSecureLogin;
3309 if ( !$wgSecureLogin ) {
3313 $https = $this->getBoolOption( 'prefershttps' );
3314 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3316 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3323 * Get the user preferred stub threshold
3327 public function getStubThreshold() {
3328 global $wgMaxArticleSize; # Maximum article size, in Kb
3329 $threshold = $this->getIntOption( 'stubthreshold' );
3330 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3331 // If they have set an impossible value, disable the preference
3332 // so we can use the parser cache again.
3339 * Get the permissions this user has.
3340 * @return string[] permission names
3342 * @deprecated since 1.34, use MediaWikiServices::getInstance()->getPermissionManager()
3343 * ->getUserPermissions(..) instead
3346 public function getRights() {
3347 return MediaWikiServices
::getInstance()->getPermissionManager()->getUserPermissions( $this );
3351 * Get the list of explicit group memberships this user has.
3352 * The implicit * and user groups are not included.
3354 * @return string[] Array of internal group names (sorted since 1.33)
3356 public function getGroups() {
3358 $this->loadGroups();
3359 return array_keys( $this->mGroupMemberships
);
3363 * Get the list of explicit group memberships this user has, stored as
3364 * UserGroupMembership objects. Implicit groups are not included.
3366 * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
3369 public function getGroupMemberships() {
3371 $this->loadGroups();
3372 return $this->mGroupMemberships
;
3376 * Get the list of implicit group memberships this user has.
3377 * This includes all explicit groups, plus 'user' if logged in,
3378 * '*' for all accounts, and autopromoted groups
3379 * @param bool $recache Whether to avoid the cache
3380 * @return array Array of String internal group names
3382 public function getEffectiveGroups( $recache = false ) {
3383 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3384 $this->mEffectiveGroups
= array_unique( array_merge(
3385 $this->getGroups(), // explicit groups
3386 $this->getAutomaticGroups( $recache ) // implicit groups
3388 // Avoid PHP 7.1 warning of passing $this by reference
3390 // Hook for additional groups
3391 Hooks
::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups
] );
3392 // Force reindexation of groups when a hook has unset one of them
3393 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3395 return $this->mEffectiveGroups
;
3399 * Get the list of implicit group memberships this user has.
3400 * This includes 'user' if logged in, '*' for all accounts,
3401 * and autopromoted groups
3402 * @param bool $recache Whether to avoid the cache
3403 * @return array Array of String internal group names
3405 public function getAutomaticGroups( $recache = false ) {
3406 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3407 $this->mImplicitGroups
= [ '*' ];
3408 if ( $this->getId() ) {
3409 $this->mImplicitGroups
[] = 'user';
3411 $this->mImplicitGroups
= array_unique( array_merge(
3412 $this->mImplicitGroups
,
3413 Autopromote
::getAutopromoteGroups( $this )
3417 // Assure data consistency with rights/groups,
3418 // as getEffectiveGroups() depends on this function
3419 $this->mEffectiveGroups
= null;
3422 return $this->mImplicitGroups
;
3426 * Returns the groups the user has belonged to.
3428 * The user may still belong to the returned groups. Compare with getGroups().
3430 * The function will not return groups the user had belonged to before MW 1.17
3432 * @return array Names of the groups the user has belonged to.
3434 public function getFormerGroups() {
3437 if ( is_null( $this->mFormerGroups
) ) {
3438 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3439 ?
wfGetDB( DB_MASTER
)
3440 : wfGetDB( DB_REPLICA
);
3441 $res = $db->select( 'user_former_groups',
3443 [ 'ufg_user' => $this->mId
],
3445 $this->mFormerGroups
= [];
3446 foreach ( $res as $row ) {
3447 $this->mFormerGroups
[] = $row->ufg_group
;
3451 return $this->mFormerGroups
;
3455 * Get the user's edit count.
3456 * @return int|null Null for anonymous users
3458 public function getEditCount() {
3459 if ( !$this->getId() ) {
3463 if ( $this->mEditCount
=== null ) {
3464 /* Populate the count, if it has not been populated yet */
3465 $dbr = wfGetDB( DB_REPLICA
);
3466 // check if the user_editcount field has been initialized
3467 $count = $dbr->selectField(
3468 'user', 'user_editcount',
3469 [ 'user_id' => $this->mId
],
3473 if ( $count === null ) {
3474 // it has not been initialized. do so.
3475 $count = $this->initEditCountInternal( $dbr );
3477 $this->mEditCount
= $count;
3479 return (int)$this->mEditCount
;
3483 * Add the user to the given group. This takes immediate effect.
3484 * If the user is already in the group, the expiry time will be updated to the new
3485 * expiry time. (If $expiry is omitted or null, the membership will be altered to
3488 * @param string $group Name of the group to add
3489 * @param string|null $expiry Optional expiry timestamp in any format acceptable to
3490 * wfTimestamp(), or null if the group assignment should not expire
3493 public function addGroup( $group, $expiry = null ) {
3495 $this->loadGroups();
3498 $expiry = wfTimestamp( TS_MW
, $expiry );
3501 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
3505 // create the new UserGroupMembership and put it in the DB
3506 $ugm = new UserGroupMembership( $this->mId
, $group, $expiry );
3507 if ( !$ugm->insert( true ) ) {
3511 $this->mGroupMemberships
[$group] = $ugm;
3513 // Refresh the groups caches, and clear the rights cache so it will be
3514 // refreshed on the next call to $this->getRights().
3515 $this->getEffectiveGroups( true );
3516 MediaWikiServices
::getInstance()->getPermissionManager()->invalidateUsersRightsCache( $this );
3517 $this->invalidateCache();
3523 * Remove the user from the given group.
3524 * This takes immediate effect.
3525 * @param string $group Name of the group to remove
3528 public function removeGroup( $group ) {
3531 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3535 $ugm = UserGroupMembership
::getMembership( $this->mId
, $group );
3536 // delete the membership entry
3537 if ( !$ugm ||
!$ugm->delete() ) {
3541 $this->loadGroups();
3542 unset( $this->mGroupMemberships
[$group] );
3544 // Refresh the groups caches, and clear the rights cache so it will be
3545 // refreshed on the next call to $this->getRights().
3546 $this->getEffectiveGroups( true );
3547 MediaWikiServices
::getInstance()->getPermissionManager()->invalidateUsersRightsCache( $this );
3548 $this->invalidateCache();
3554 * Alias of isLoggedIn() with a name that describes its actual functionality. UserIdentity has
3555 * only this new name and not the old isLoggedIn() variant.
3557 * @return bool True if user is registered on this wiki, i.e., has a user ID. False if user is
3558 * anonymous or has no local account (which can happen when importing). This is equivalent to
3559 * getId() != 0 and is provided for code readability.
3562 public function isRegistered() {
3563 return $this->getId() != 0;
3567 * Get whether the user is logged in
3570 public function isLoggedIn() {
3571 return $this->isRegistered();
3575 * Get whether the user is anonymous
3578 public function isAnon() {
3579 return !$this->isRegistered();
3583 * @return bool Whether this user is flagged as being a bot role account
3586 public function isBot() {
3587 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3592 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3598 * Check if user is allowed to access a feature / make an action
3600 * @deprecated since 1.34, use MediaWikiServices::getInstance()
3601 * ->getPermissionManager()->userHasAnyRights(...) instead
3603 * @param string $permissions,... Permissions to test
3604 * @return bool True if user is allowed to perform *any* of the given actions
3606 public function isAllowedAny() {
3607 return MediaWikiServices
::getInstance()
3608 ->getPermissionManager()
3609 ->userHasAnyRight( $this, ...func_get_args() );
3613 * @deprecated since 1.34, use MediaWikiServices::getInstance()
3614 * ->getPermissionManager()->userHasAllRights(...) instead
3615 * @param string $permissions,... Permissions to test
3616 * @return bool True if the user is allowed to perform *all* of the given actions
3618 public function isAllowedAll() {
3619 return MediaWikiServices
::getInstance()
3620 ->getPermissionManager()
3621 ->userHasAllRights( $this, ...func_get_args() );
3625 * Internal mechanics of testing a permission
3627 * @deprecated since 1.34, use MediaWikiServices::getInstance()
3628 * ->getPermissionManager()->userHasRight(...) instead
3630 * @param string $action
3634 public function isAllowed( $action = '' ) {
3635 return MediaWikiServices
::getInstance()->getPermissionManager()
3636 ->userHasRight( $this, $action );
3640 * Check whether to enable recent changes patrol features for this user
3641 * @return bool True or false
3643 public function useRCPatrol() {
3644 global $wgUseRCPatrol;
3645 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3649 * Check whether to enable new pages patrol features for this user
3650 * @return bool True or false
3652 public function useNPPatrol() {
3653 global $wgUseRCPatrol, $wgUseNPPatrol;
3655 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3656 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3661 * Check whether to enable new files patrol features for this user
3662 * @return bool True or false
3664 public function useFilePatrol() {
3665 global $wgUseRCPatrol, $wgUseFilePatrol;
3667 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3668 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3673 * Get the WebRequest object to use with this object
3675 * @return WebRequest
3677 public function getRequest() {
3678 if ( $this->mRequest
) {
3679 return $this->mRequest
;
3687 * Check the watched status of an article.
3688 * @since 1.22 $checkRights parameter added
3689 * @param Title $title Title of the article to look at
3690 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3691 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3694 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3695 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3696 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3703 * @since 1.22 $checkRights parameter added
3704 * @param Title $title Title of the article to look at
3705 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3706 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3708 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3709 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3710 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3712 [ $title->getSubjectPage(), $title->getTalkPage() ]
3715 $this->invalidateCache();
3719 * Stop watching an article.
3720 * @since 1.22 $checkRights parameter added
3721 * @param Title $title Title of the article to look at
3722 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3723 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3725 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3726 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3727 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3728 $store->removeWatch( $this, $title->getSubjectPage() );
3729 $store->removeWatch( $this, $title->getTalkPage() );
3731 $this->invalidateCache();
3735 * Clear the user's notification timestamp for the given title.
3736 * If e-notif e-mails are on, they will receive notification mails on
3737 * the next change of the page if it's watched etc.
3738 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3739 * @param Title &$title Title of the article to look at
3740 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3742 public function clearNotification( &$title, $oldid = 0 ) {
3743 global $wgUseEnotif, $wgShowUpdatedMarker;
3745 // Do nothing if the database is locked to writes
3746 if ( wfReadOnly() ) {
3750 // Do nothing if not allowed to edit the watchlist
3751 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3755 // If we're working on user's talk page, we should update the talk page message indicator
3756 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3757 // Avoid PHP 7.1 warning of passing $this by reference
3759 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
3763 // Try to update the DB post-send and only if needed...
3764 DeferredUpdates
::addCallableUpdate( function () use ( $title, $oldid ) {
3765 if ( !$this->getNewtalk() ) {
3766 return; // no notifications to clear
3769 // Delete the last notifications (they stack up)
3770 $this->setNewtalk( false );
3772 // If there is a new, unseen, revision, use its timestamp
3774 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
3777 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
3782 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3786 if ( $this->isAnon() ) {
3787 // Nothing else to do...
3791 // Only update the timestamp if the page is being watched.
3792 // The query to find out if it is watched is cached both in memcached and per-invocation,
3793 // and when it does have to be executed, it can be on a replica DB
3794 // If this is the user's newtalk page, we always update the timestamp
3796 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3800 MediaWikiServices
::getInstance()->getWatchedItemStore()
3801 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
3805 * Resets all of the given user's page-change notification timestamps.
3806 * If e-notif e-mails are on, they will receive notification mails on
3807 * the next change of any watched page.
3808 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3810 public function clearAllNotifications() {
3811 global $wgUseEnotif, $wgShowUpdatedMarker;
3812 // Do nothing if not allowed to edit the watchlist
3813 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
3817 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3818 $this->setNewtalk( false );
3822 $id = $this->getId();
3827 $watchedItemStore = MediaWikiServices
::getInstance()->getWatchedItemStore();
3828 $watchedItemStore->resetAllNotificationTimestampsForUser( $this );
3830 // We also need to clear here the "you have new message" notification for the own
3831 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
3835 * Compute experienced level based on edit count and registration date.
3837 * @return string 'newcomer', 'learner', or 'experienced'
3839 public function getExperienceLevel() {
3840 global $wgLearnerEdits,
3841 $wgExperiencedUserEdits,
3842 $wgLearnerMemberSince,
3843 $wgExperiencedUserMemberSince;
3845 if ( $this->isAnon() ) {
3849 $editCount = $this->getEditCount();
3850 $registration = $this->getRegistration();
3852 $learnerRegistration = wfTimestamp( TS_MW
, $now - $wgLearnerMemberSince * 86400 );
3853 $experiencedRegistration = wfTimestamp( TS_MW
, $now - $wgExperiencedUserMemberSince * 86400 );
3855 if ( $editCount < $wgLearnerEdits ||
3856 $registration > $learnerRegistration ) {
3860 if ( $editCount > $wgExperiencedUserEdits &&
3861 $registration <= $experiencedRegistration
3863 return 'experienced';
3870 * Persist this user's session (e.g. set cookies)
3872 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3874 * @param bool|null $secure Whether to force secure/insecure cookies or use default
3875 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3877 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3879 if ( $this->mId
== 0 ) {
3883 $session = $this->getRequest()->getSession();
3884 if ( $request && $session->getRequest() !== $request ) {
3885 $session = $session->sessionWithRequest( $request );
3887 $delay = $session->delaySave();
3889 if ( !$session->getUser()->equals( $this ) ) {
3890 if ( !$session->canSetUser() ) {
3891 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3892 ->warning( __METHOD__
.
3893 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
3897 $session->setUser( $this );
3900 $session->setRememberUser( $rememberMe );
3901 if ( $secure !== null ) {
3902 $session->setForceHTTPS( $secure );
3905 $session->persist();
3907 ScopedCallback
::consume( $delay );
3911 * Log this user out.
3913 public function logout() {
3914 // Avoid PHP 7.1 warning of passing $this by reference
3916 if ( Hooks
::run( 'UserLogout', [ &$user ] ) ) {
3922 * Clear the user's session, and reset the instance cache.
3925 public function doLogout() {
3926 $session = $this->getRequest()->getSession();
3927 if ( !$session->canSetUser() ) {
3928 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3929 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
3930 $error = 'immutable';
3931 } elseif ( !$session->getUser()->equals( $this ) ) {
3932 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3933 ->warning( __METHOD__
.
3934 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
3936 // But we still may as well make this user object anon
3937 $this->clearInstanceCache( 'defaults' );
3938 $error = 'wronguser';
3940 $this->clearInstanceCache( 'defaults' );
3941 $delay = $session->delaySave();
3942 $session->unpersist(); // Clear cookies (T127436)
3943 $session->setLoggedOutTimestamp( time() );
3944 $session->setUser( new User
);
3945 $session->set( 'wsUserID', 0 ); // Other code expects this
3946 $session->resetAllTokens();
3947 ScopedCallback
::consume( $delay );
3950 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
3951 'event' => 'logout',
3952 'successful' => $error === false,
3953 'status' => $error ?
: 'success',
3958 * Save this user's settings into the database.
3959 * @todo Only rarely do all these fields need to be set!
3961 public function saveSettings() {
3962 if ( wfReadOnly() ) {
3963 // @TODO: caller should deal with this instead!
3964 // This should really just be an exception.
3965 MWExceptionHandler
::logException( new DBExpectedError(
3967 "Could not update user with ID '{$this->mId}'; DB is read-only."
3973 if ( $this->mId
== 0 ) {
3977 // Get a new user_touched that is higher than the old one.
3978 // This will be used for a CAS check as a last-resort safety
3979 // check against race conditions and replica DB lag.
3980 $newTouched = $this->newTouchedTimestamp();
3982 $dbw = wfGetDB( DB_MASTER
);
3983 $dbw->doAtomicSection( __METHOD__
, function ( IDatabase
$dbw, $fname ) use ( $newTouched ) {
3984 global $wgActorTableSchemaMigrationStage;
3986 $dbw->update( 'user',
3988 'user_name' => $this->mName
,
3989 'user_real_name' => $this->mRealName
,
3990 'user_email' => $this->mEmail
,
3991 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3992 'user_touched' => $dbw->timestamp( $newTouched ),
3993 'user_token' => strval( $this->mToken
),
3994 'user_email_token' => $this->mEmailToken
,
3995 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
3996 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
3997 'user_id' => $this->mId
,
4001 if ( !$dbw->affectedRows() ) {
4002 // Maybe the problem was a missed cache update; clear it to be safe
4003 $this->clearSharedCache( 'refresh' );
4004 // User was changed in the meantime or loaded with stale data
4005 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
4006 LoggerFactory
::getInstance( 'preferences' )->warning(
4007 "CAS update failed on user_touched for user ID '{user_id}' ({db_flag} read)",
4008 [ 'user_id' => $this->mId
, 'db_flag' => $from ]
4010 throw new MWException( "CAS update failed on user_touched. " .
4011 "The version of the user to be saved is older than the current version."
4015 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4018 [ 'actor_name' => $this->mName
],
4019 [ 'actor_user' => $this->mId
],
4025 $this->mTouched
= $newTouched;
4026 $this->saveOptions();
4028 Hooks
::run( 'UserSaveSettings', [ $this ] );
4029 $this->clearSharedCache( 'changed' );
4030 $this->getUserPage()->purgeSquid();
4034 * If only this user's username is known, and it exists, return the user ID.
4036 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
4039 public function idForName( $flags = 0 ) {
4040 $s = trim( $this->getName() );
4045 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
4046 ?
wfGetDB( DB_MASTER
)
4047 : wfGetDB( DB_REPLICA
);
4049 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
4050 ?
[ 'LOCK IN SHARE MODE' ]
4053 $id = $db->selectField( 'user',
4054 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
4060 * Add a user to the database, return the user object
4062 * @param string $name Username to add
4063 * @param array $params Array of Strings Non-default parameters to save to
4064 * the database as user_* fields:
4065 * - email: The user's email address.
4066 * - email_authenticated: The email authentication timestamp.
4067 * - real_name: The user's real name.
4068 * - options: An associative array of non-default options.
4069 * - token: Random authentication token. Do not set.
4070 * - registration: Registration timestamp. Do not set.
4072 * @return User|null User object, or null if the username already exists.
4074 public static function createNew( $name, $params = [] ) {
4075 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
4076 if ( isset( $params[$field] ) ) {
4077 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
4078 unset( $params[$field] );
4084 $user->setToken(); // init token
4085 if ( isset( $params['options'] ) ) {
4086 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
4087 unset( $params['options'] );
4089 $dbw = wfGetDB( DB_MASTER
);
4091 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4094 'user_name' => $name,
4095 'user_password' => $noPass,
4096 'user_newpassword' => $noPass,
4097 'user_email' => $user->mEmail
,
4098 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
4099 'user_real_name' => $user->mRealName
,
4100 'user_token' => strval( $user->mToken
),
4101 'user_registration' => $dbw->timestamp( $user->mRegistration
),
4102 'user_editcount' => 0,
4103 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4105 foreach ( $params as $name => $value ) {
4106 $fields["user_$name"] = $value;
4109 return $dbw->doAtomicSection( __METHOD__
, function ( IDatabase
$dbw, $fname ) use ( $fields ) {
4110 $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
4111 if ( $dbw->affectedRows() ) {
4112 $newUser = self
::newFromId( $dbw->insertId() );
4113 $newUser->mName
= $fields['user_name'];
4114 $newUser->updateActorId( $dbw );
4115 // Load the user from master to avoid replica lag
4116 $newUser->load( self
::READ_LATEST
);
4125 * Add this existing user object to the database. If the user already
4126 * exists, a fatal status object is returned, and the user object is
4127 * initialised with the data from the database.
4129 * Previously, this function generated a DB error due to a key conflict
4130 * if the user already existed. Many extension callers use this function
4131 * in code along the lines of:
4133 * $user = User::newFromName( $name );
4134 * if ( !$user->isLoggedIn() ) {
4135 * $user->addToDatabase();
4137 * // do something with $user...
4139 * However, this was vulnerable to a race condition (T18020). By
4140 * initialising the user object if the user exists, we aim to support this
4141 * calling sequence as far as possible.
4143 * Note that if the user exists, this function will acquire a write lock,
4144 * so it is still advisable to make the call conditional on isLoggedIn(),
4145 * and to commit the transaction after calling.
4147 * @throws MWException
4150 public function addToDatabase() {
4152 if ( !$this->mToken
) {
4153 $this->setToken(); // init token
4156 if ( !is_string( $this->mName
) ) {
4157 throw new RuntimeException( "User name field is not set." );
4160 $this->mTouched
= $this->newTouchedTimestamp();
4162 $dbw = wfGetDB( DB_MASTER
);
4163 $status = $dbw->doAtomicSection( __METHOD__
, function ( IDatabase
$dbw, $fname ) {
4164 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4165 $dbw->insert( 'user',
4167 'user_name' => $this->mName
,
4168 'user_password' => $noPass,
4169 'user_newpassword' => $noPass,
4170 'user_email' => $this->mEmail
,
4171 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4172 'user_real_name' => $this->mRealName
,
4173 'user_token' => strval( $this->mToken
),
4174 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4175 'user_editcount' => 0,
4176 'user_touched' => $dbw->timestamp( $this->mTouched
),
4180 if ( !$dbw->affectedRows() ) {
4181 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4182 $this->mId
= $dbw->selectField(
4185 [ 'user_name' => $this->mName
],
4187 [ 'LOCK IN SHARE MODE' ]
4190 if ( $this->mId
&& $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4194 throw new MWException( $fname . ": hit a key conflict attempting " .
4195 "to insert user '{$this->mName}' row, but it was not present in select!" );
4197 return Status
::newFatal( 'userexists' );
4199 $this->mId
= $dbw->insertId();
4200 self
::$idCacheByName[$this->mName
] = $this->mId
;
4201 $this->updateActorId( $dbw );
4203 return Status
::newGood();
4205 if ( !$status->isGood() ) {
4209 // Clear instance cache other than user table data and actor, which is already accurate
4210 $this->clearInstanceCache();
4212 $this->saveOptions();
4213 return Status
::newGood();
4217 * Update the actor ID after an insert
4218 * @param IDatabase $dbw Writable database handle
4220 private function updateActorId( IDatabase
$dbw ) {
4221 global $wgActorTableSchemaMigrationStage;
4223 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4226 [ 'actor_user' => $this->mId
, 'actor_name' => $this->mName
],
4229 $this->mActorId
= (int)$dbw->insertId();
4234 * If this user is logged-in and blocked,
4235 * block any IP address they've successfully logged in from.
4236 * @return bool A block was spread
4238 public function spreadAnyEditBlock() {
4239 if ( $this->isLoggedIn() && $this->getBlock() ) {
4240 return $this->spreadBlock();
4247 * If this (non-anonymous) user is blocked,
4248 * block the IP address they've successfully logged in from.
4249 * @return bool A block was spread
4251 protected function spreadBlock() {
4252 wfDebug( __METHOD__
. "()\n" );
4254 if ( $this->mId
== 0 ) {
4258 $userblock = DatabaseBlock
::newFromTarget( $this->getName() );
4259 if ( !$userblock ) {
4263 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4267 * Get whether the user is explicitly blocked from account creation.
4268 * @return bool|AbstractBlock
4270 public function isBlockedFromCreateAccount() {
4271 $this->getBlockedStatus();
4272 if ( $this->mBlock
&& $this->mBlock
->appliesToRight( 'createaccount' ) ) {
4273 return $this->mBlock
;
4276 # T15611: if the IP address the user is trying to create an account from is
4277 # blocked with createaccount disabled, prevent new account creation there even
4278 # when the user is logged in
4279 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4280 $this->mBlockedFromCreateAccount
= DatabaseBlock
::newFromTarget(
4281 null, $this->getRequest()->getIP()
4284 return $this->mBlockedFromCreateAccount
instanceof AbstractBlock
4285 && $this->mBlockedFromCreateAccount
->appliesToRight( 'createaccount' )
4286 ?
$this->mBlockedFromCreateAccount
4291 * Get whether the user is blocked from using Special:Emailuser.
4294 public function isBlockedFromEmailuser() {
4295 $this->getBlockedStatus();
4296 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'sendemail' );
4300 * Get whether the user is blocked from using Special:Upload
4305 public function isBlockedFromUpload() {
4306 $this->getBlockedStatus();
4307 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'upload' );
4311 * Get whether the user is allowed to create an account.
4314 public function isAllowedToCreateAccount() {
4315 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4319 * Get this user's personal page title.
4321 * @return Title User's personal page title
4323 public function getUserPage() {
4324 return Title
::makeTitle( NS_USER
, $this->getName() );
4328 * Get this user's talk page title.
4330 * @return Title User's talk page title
4332 public function getTalkPage() {
4333 $title = $this->getUserPage();
4334 return $title->getTalkPage();
4338 * Determine whether the user is a newbie. Newbies are either
4339 * anonymous IPs, or the most recently created accounts.
4342 public function isNewbie() {
4343 return !$this->isAllowed( 'autoconfirmed' );
4347 * Check to see if the given clear-text password is one of the accepted passwords
4348 * @deprecated since 1.27, use AuthManager instead
4349 * @param string $password User password
4350 * @return bool True if the given password is correct, otherwise False
4352 public function checkPassword( $password ) {
4353 wfDeprecated( __METHOD__
, '1.27' );
4355 $manager = AuthManager
::singleton();
4356 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4357 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4359 'username' => $this->getName(),
4360 'password' => $password,
4363 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4364 switch ( $res->status
) {
4365 case AuthenticationResponse
::PASS
:
4367 case AuthenticationResponse
::FAIL
:
4368 // Hope it's not a PreAuthenticationProvider that failed...
4369 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4370 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4373 throw new BadMethodCallException(
4374 'AuthManager returned a response unsupported by ' . __METHOD__
4380 * Check if the given clear-text password matches the temporary password
4381 * sent by e-mail for password reset operations.
4383 * @deprecated since 1.27, use AuthManager instead
4384 * @param string $plaintext
4385 * @return bool True if matches, false otherwise
4387 public function checkTemporaryPassword( $plaintext ) {
4388 wfDeprecated( __METHOD__
, '1.27' );
4389 // Can't check the temporary password individually.
4390 return $this->checkPassword( $plaintext );
4394 * Initialize (if necessary) and return a session token value
4395 * which can be used in edit forms to show that the user's
4396 * login credentials aren't being hijacked with a foreign form
4400 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4401 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4402 * @return MediaWiki\Session\Token The new edit token
4404 public function getEditTokenObject( $salt = '', $request = null ) {
4405 if ( $this->isAnon() ) {
4406 return new LoggedOutEditToken();
4410 $request = $this->getRequest();
4412 return $request->getSession()->getToken( $salt );
4416 * Initialize (if necessary) and return a session token value
4417 * which can be used in edit forms to show that the user's
4418 * login credentials aren't being hijacked with a foreign form
4421 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4424 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4425 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4426 * @return string The new edit token
4428 public function getEditToken( $salt = '', $request = null ) {
4429 return $this->getEditTokenObject( $salt, $request )->toString();
4433 * Check given value against the token value stored in the session.
4434 * A match should confirm that the form was submitted from the
4435 * user's own login session, not a form submission from a third-party
4438 * @param string $val Input value to compare
4439 * @param string|array $salt Optional function-specific data for hashing
4440 * @param WebRequest|null $request Object to use or null to use $wgRequest
4441 * @param int|null $maxage Fail tokens older than this, in seconds
4442 * @return bool Whether the token matches
4444 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4445 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4449 * Check given value against the token value stored in the session,
4450 * ignoring the suffix.
4452 * @param string $val Input value to compare
4453 * @param string|array $salt Optional function-specific data for hashing
4454 * @param WebRequest|null $request Object to use or null to use $wgRequest
4455 * @param int|null $maxage Fail tokens older than this, in seconds
4456 * @return bool Whether the token matches
4458 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4459 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4460 return $this->matchEditToken( $val, $salt, $request, $maxage );
4464 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4465 * mail to the user's given address.
4467 * @param string $type Message to send, either "created", "changed" or "set"
4470 public function sendConfirmationMail( $type = 'created' ) {
4472 $expiration = null; // gets passed-by-ref and defined in next line.
4473 $token = $this->confirmationToken( $expiration );
4474 $url = $this->confirmationTokenUrl( $token );
4475 $invalidateURL = $this->invalidationTokenUrl( $token );
4476 $this->saveSettings();
4478 if ( $type == 'created' ||
$type === false ) {
4479 $message = 'confirmemail_body';
4481 } elseif ( $type === true ) {
4482 $message = 'confirmemail_body_changed';
4485 // Messages: confirmemail_body_changed, confirmemail_body_set
4486 $message = 'confirmemail_body_' . $type;
4490 'subject' => wfMessage( 'confirmemail_subject' )->text(),
4491 'body' => wfMessage( $message,
4492 $this->getRequest()->getIP(),
4495 $wgLang->userTimeAndDate( $expiration, $this ),
4497 $wgLang->userDate( $expiration, $this ),
4498 $wgLang->userTime( $expiration, $this ) )->text(),
4504 'ip' => $this->getRequest()->getIP(),
4505 'confirmURL' => $url,
4506 'invalidateURL' => $invalidateURL,
4507 'expiration' => $expiration
4510 Hooks
::run( 'UserSendConfirmationMail', [ $this, &$mail, $info ] );
4511 return $this->sendMail( $mail['subject'], $mail['body'], $mail['from'], $mail['replyTo'] );
4515 * Send an e-mail to this user's account. Does not check for
4516 * confirmed status or validity.
4518 * @param string $subject Message subject
4519 * @param string $body Message body
4520 * @param User|null $from Optional sending user; if unspecified, default
4521 * $wgPasswordSender will be used.
4522 * @param MailAddress|null $replyto Reply-To address
4525 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4526 global $wgPasswordSender;
4528 if ( $from instanceof User
) {
4529 $sender = MailAddress
::newFromUser( $from );
4531 $sender = new MailAddress( $wgPasswordSender,
4532 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4534 $to = MailAddress
::newFromUser( $this );
4536 return UserMailer
::send( $to, $sender, $subject, $body, [
4537 'replyTo' => $replyto,
4542 * Generate, store, and return a new e-mail confirmation code.
4543 * A hash (unsalted, since it's used as a key) is stored.
4545 * @note Call saveSettings() after calling this function to commit
4546 * this change to the database.
4548 * @param string &$expiration Accepts the expiration time
4549 * @return string New token
4551 protected function confirmationToken( &$expiration ) {
4552 global $wgUserEmailConfirmationTokenExpiry;
4554 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4555 $expiration = wfTimestamp( TS_MW
, $expires );
4557 $token = MWCryptRand
::generateHex( 32 );
4558 $hash = md5( $token );
4559 $this->mEmailToken
= $hash;
4560 $this->mEmailTokenExpires
= $expiration;
4565 * Return a URL the user can use to confirm their email address.
4566 * @param string $token Accepts the email confirmation token
4567 * @return string New token URL
4569 protected function confirmationTokenUrl( $token ) {
4570 return $this->getTokenUrl( 'ConfirmEmail', $token );
4574 * Return a URL the user can use to invalidate their email address.
4575 * @param string $token Accepts the email confirmation token
4576 * @return string New token URL
4578 protected function invalidationTokenUrl( $token ) {
4579 return $this->getTokenUrl( 'InvalidateEmail', $token );
4583 * Internal function to format the e-mail validation/invalidation URLs.
4584 * This uses a quickie hack to use the
4585 * hardcoded English names of the Special: pages, for ASCII safety.
4587 * @note Since these URLs get dropped directly into emails, using the
4588 * short English names avoids insanely long URL-encoded links, which
4589 * also sometimes can get corrupted in some browsers/mailers
4590 * (T8957 with Gmail and Internet Explorer).
4592 * @param string $page Special page
4593 * @param string $token
4594 * @return string Formatted URL
4596 protected function getTokenUrl( $page, $token ) {
4597 // Hack to bypass localization of 'Special:'
4598 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4599 return $title->getCanonicalURL();
4603 * Mark the e-mail address confirmed.
4605 * @note Call saveSettings() after calling this function to commit the change.
4609 public function confirmEmail() {
4610 // Check if it's already confirmed, so we don't touch the database
4611 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4612 if ( !$this->isEmailConfirmed() ) {
4613 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4614 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4620 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4621 * address if it was already confirmed.
4623 * @note Call saveSettings() after calling this function to commit the change.
4624 * @return bool Returns true
4626 public function invalidateEmail() {
4628 $this->mEmailToken
= null;
4629 $this->mEmailTokenExpires
= null;
4630 $this->setEmailAuthenticationTimestamp( null );
4632 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4637 * Set the e-mail authentication timestamp.
4638 * @param string $timestamp TS_MW timestamp
4640 public function setEmailAuthenticationTimestamp( $timestamp ) {
4642 $this->mEmailAuthenticated
= $timestamp;
4643 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4647 * Is this user allowed to send e-mails within limits of current
4648 * site configuration?
4651 public function canSendEmail() {
4652 global $wgEnableEmail, $wgEnableUserEmail;
4653 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4656 $canSend = $this->isEmailConfirmed();
4657 // Avoid PHP 7.1 warning of passing $this by reference
4659 Hooks
::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
4664 * Is this user allowed to receive e-mails within limits of current
4665 * site configuration?
4668 public function canReceiveEmail() {
4669 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4673 * Is this user's e-mail address valid-looking and confirmed within
4674 * limits of the current site configuration?
4676 * @note If $wgEmailAuthentication is on, this may require the user to have
4677 * confirmed their address by returning a code or using a password
4678 * sent to the address from the wiki.
4682 public function isEmailConfirmed() {
4683 global $wgEmailAuthentication;
4685 // Avoid PHP 7.1 warning of passing $this by reference
4688 if ( Hooks
::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
4689 if ( $this->isAnon() ) {
4692 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4695 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4705 * Check whether there is an outstanding request for e-mail confirmation.
4708 public function isEmailConfirmationPending() {
4709 global $wgEmailAuthentication;
4710 return $wgEmailAuthentication &&
4711 !$this->isEmailConfirmed() &&
4712 $this->mEmailToken
&&
4713 $this->mEmailTokenExpires
> wfTimestamp();
4717 * Get the timestamp of account creation.
4719 * @return string|bool|null Timestamp of account creation, false for
4720 * non-existent/anonymous user accounts, or null if existing account
4721 * but information is not in database.
4723 public function getRegistration() {
4724 if ( $this->isAnon() ) {
4728 return $this->mRegistration
;
4732 * Get the timestamp of the first edit
4734 * @return string|bool Timestamp of first edit, or false for
4735 * non-existent/anonymous user accounts.
4737 public function getFirstEditTimestamp() {
4738 return $this->getEditTimestamp( true );
4742 * Get the timestamp of the latest edit
4745 * @return string|bool Timestamp of first edit, or false for
4746 * non-existent/anonymous user accounts.
4748 public function getLatestEditTimestamp() {
4749 return $this->getEditTimestamp( false );
4753 * Get the timestamp of the first or latest edit
4755 * @param bool $first True for the first edit, false for the latest one
4756 * @return string|bool Timestamp of first or latest edit, or false for
4757 * non-existent/anonymous user accounts.
4759 private function getEditTimestamp( $first ) {
4760 if ( $this->getId() == 0 ) {
4761 return false; // anons
4763 $dbr = wfGetDB( DB_REPLICA
);
4764 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
4765 $tsField = isset( $actorWhere['tables']['temp_rev_user'] )
4766 ?
'revactor_timestamp' : 'rev_timestamp';
4767 $sortOrder = $first ?
'ASC' : 'DESC';
4768 $time = $dbr->selectField(
4769 [ 'revision' ] +
$actorWhere['tables'],
4771 [ $actorWhere['conds'] ],
4773 [ 'ORDER BY' => "$tsField $sortOrder" ],
4774 $actorWhere['joins']
4777 return false; // no edits
4779 return wfTimestamp( TS_MW
, $time );
4783 * Get the permissions associated with a given list of groups
4785 * @deprecated since 1.34, use MediaWikiServices::getInstance()->getPermissionManager()
4786 * ->getGroupPermissions() instead
4788 * @param array $groups Array of Strings List of internal group names
4789 * @return array Array of Strings List of permission key names for given groups combined
4791 public static function getGroupPermissions( $groups ) {
4792 return MediaWikiServices
::getInstance()->getPermissionManager()->getGroupPermissions( $groups );
4796 * Get all the groups who have a given permission
4798 * @deprecated since 1.34, use MediaWikiServices::getInstance()->getPermissionManager()
4799 * ->getGroupsWithPermission() instead
4801 * @param string $role Role to check
4802 * @return array Array of Strings List of internal group names with the given permission
4804 public static function getGroupsWithPermission( $role ) {
4805 return MediaWikiServices
::getInstance()->getPermissionManager()->getGroupsWithPermission( $role );
4809 * Check, if the given group has the given permission
4811 * If you're wanting to check whether all users have a permission, use
4812 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4815 * @deprecated since 1.34, use MediaWikiServices::getInstance()->getPermissionManager()
4816 * ->groupHasPermission(..) instead
4819 * @param string $group Group to check
4820 * @param string $role Role to check
4823 public static function groupHasPermission( $group, $role ) {
4824 return MediaWikiServices
::getInstance()->getPermissionManager()
4825 ->groupHasPermission( $group, $role );
4829 * Check if all users may be assumed to have the given permission
4831 * We generally assume so if the right is granted to '*' and isn't revoked
4832 * on any group. It doesn't attempt to take grants or other extension
4833 * limitations on rights into account in the general case, though, as that
4834 * would require it to always return false and defeat the purpose.
4835 * Specifically, session-based rights restrictions (such as OAuth or bot
4836 * passwords) are applied based on the current session.
4838 * @deprecated since 1.34, use MediaWikiServices::getInstance()->getPermissionManager()
4839 * ->isEveryoneAllowed() instead
4841 * @param string $right Right to check
4846 public static function isEveryoneAllowed( $right ) {
4847 return MediaWikiServices
::getInstance()->getPermissionManager()->isEveryoneAllowed( $right );
4851 * Return the set of defined explicit groups.
4852 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4853 * are not included, as they are defined automatically, not in the database.
4854 * @return array Array of internal group names
4856 public static function getAllGroups() {
4857 global $wgGroupPermissions, $wgRevokePermissions;
4858 return array_values( array_diff(
4859 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4860 self
::getImplicitGroups()
4865 * Get a list of all available permissions.
4867 * @deprecated since 1.34, use MediaWikiServices::getInstance()->getPermissionManager()
4868 * ->getAllPermissions() instead
4870 * @return string[] Array of permission names
4872 public static function getAllRights() {
4873 return MediaWikiServices
::getInstance()->getPermissionManager()->getAllPermissions();
4877 * Get a list of implicit groups
4878 * TODO: Should we deprecate this? It's trivial, but we don't want to encourage use of globals.
4880 * @return array Array of Strings Array of internal group names
4882 public static function getImplicitGroups() {
4883 global $wgImplicitGroups;
4884 return $wgImplicitGroups;
4888 * Returns an array of the groups that a particular group can add/remove.
4890 * @param string $group The group to check for whether it can add/remove
4891 * @return array [ 'add' => [ addablegroups ],
4892 * 'remove' => [ removablegroups ],
4893 * 'add-self' => [ addablegroups to self ],
4894 * 'remove-self' => [ removable groups from self ] ]
4896 public static function changeableByGroup( $group ) {
4897 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4906 if ( empty( $wgAddGroups[$group] ) ) {
4907 // Don't add anything to $groups
4908 } elseif ( $wgAddGroups[$group] === true ) {
4909 // You get everything
4910 $groups['add'] = self
::getAllGroups();
4911 } elseif ( is_array( $wgAddGroups[$group] ) ) {
4912 $groups['add'] = $wgAddGroups[$group];
4915 // Same thing for remove
4916 if ( empty( $wgRemoveGroups[$group] ) ) {
4918 } elseif ( $wgRemoveGroups[$group] === true ) {
4919 $groups['remove'] = self
::getAllGroups();
4920 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4921 $groups['remove'] = $wgRemoveGroups[$group];
4924 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4925 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
4926 foreach ( $wgGroupsAddToSelf as $key => $value ) {
4927 if ( is_int( $key ) ) {
4928 $wgGroupsAddToSelf['user'][] = $value;
4933 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
4934 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4935 if ( is_int( $key ) ) {
4936 $wgGroupsRemoveFromSelf['user'][] = $value;
4941 // Now figure out what groups the user can add to him/herself
4942 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
4944 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
4945 // No idea WHY this would be used, but it's there
4946 $groups['add-self'] = self
::getAllGroups();
4947 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4948 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4951 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4953 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4954 $groups['remove-self'] = self
::getAllGroups();
4955 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4956 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4963 * Returns an array of groups that this user can add and remove
4964 * @return array [ 'add' => [ addablegroups ],
4965 * 'remove' => [ removablegroups ],
4966 * 'add-self' => [ addablegroups to self ],
4967 * 'remove-self' => [ removable groups from self ] ]
4969 public function changeableGroups() {
4970 if ( $this->isAllowed( 'userrights' ) ) {
4971 // This group gives the right to modify everything (reverse-
4972 // compatibility with old "userrights lets you change
4974 // Using array_merge to make the groups reindexed
4975 $all = array_merge( self
::getAllGroups() );
4984 // Okay, it's not so simple, we will have to go through the arrays
4991 $addergroups = $this->getEffectiveGroups();
4993 foreach ( $addergroups as $addergroup ) {
4994 $groups = array_merge_recursive(
4995 $groups, $this->changeableByGroup( $addergroup )
4997 $groups['add'] = array_unique( $groups['add'] );
4998 $groups['remove'] = array_unique( $groups['remove'] );
4999 $groups['add-self'] = array_unique( $groups['add-self'] );
5000 $groups['remove-self'] = array_unique( $groups['remove-self'] );
5006 * Schedule a deferred update to update the user's edit count
5008 public function incEditCount() {
5009 if ( $this->isAnon() ) {
5013 DeferredUpdates
::addUpdate(
5014 new UserEditCountUpdate( $this, 1 ),
5015 DeferredUpdates
::POSTSEND
5020 * This method should not be called outside User/UserEditCountUpdate
5024 public function setEditCountInternal( $count ) {
5025 $this->mEditCount
= $count;
5029 * Initialize user_editcount from data out of the revision table
5031 * @internal This method should not be called outside User/UserEditCountUpdate
5032 * @param IDatabase $dbr Replica database
5033 * @return int Number of edits
5035 public function initEditCountInternal( IDatabase
$dbr ) {
5036 // Pull from a replica DB to be less cruel to servers
5037 // Accuracy isn't the point anyway here
5038 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5039 $count = (int)$dbr->selectField(
5040 [ 'revision' ] +
$actorWhere['tables'],
5042 [ $actorWhere['conds'] ],
5045 $actorWhere['joins']
5048 $dbw = wfGetDB( DB_MASTER
);
5051 [ 'user_editcount' => $count ],
5053 'user_id' => $this->getId(),
5054 'user_editcount IS NULL OR user_editcount < ' . (int)$count
5063 * Get the description of a given right
5066 * @param string $right Right to query
5067 * @return string Localized description of the right
5069 public static function getRightDescription( $right ) {
5070 $key = "right-$right";
5071 $msg = wfMessage( $key );
5072 return $msg->isDisabled() ?
$right : $msg->text();
5076 * Get the name of a given grant
5079 * @param string $grant Grant to query
5080 * @return string Localized name of the grant
5082 public static function getGrantName( $grant ) {
5083 $key = "grant-$grant";
5084 $msg = wfMessage( $key );
5085 return $msg->isDisabled() ?
$grant : $msg->text();
5089 * Add a newuser log entry for this user.
5090 * Before 1.19 the return value was always true.
5092 * @deprecated since 1.27, AuthManager handles logging
5093 * @param string|bool $action Account creation type.
5094 * - String, one of the following values:
5095 * - 'create' for an anonymous user creating an account for himself.
5096 * This will force the action's performer to be the created user itself,
5097 * no matter the value of $wgUser
5098 * - 'create2' for a logged in user creating an account for someone else
5099 * - 'byemail' when the created user will receive its password by e-mail
5100 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5101 * - Boolean means whether the account was created by e-mail (deprecated):
5102 * - true will be converted to 'byemail'
5103 * - false will be converted to 'create' if this object is the same as
5104 * $wgUser and to 'create2' otherwise
5105 * @param string $reason User supplied reason
5108 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5109 return true; // disabled
5113 * Add an autocreate newuser log entry for this user
5114 * Used by things like CentralAuth and perhaps other authplugins.
5115 * Consider calling addNewUserLogEntry() directly instead.
5117 * @deprecated since 1.27, AuthManager handles logging
5120 public function addNewUserLogEntryAutoCreate() {
5121 $this->addNewUserLogEntry( 'autocreate' );
5127 * Load the user options either from cache, the database or an array
5129 * @param array|null $data Rows for the current user out of the user_properties table
5131 protected function loadOptions( $data = null ) {
5134 if ( $this->mOptionsLoaded
) {
5138 $this->mOptions
= self
::getDefaultOptions();
5140 if ( !$this->getId() ) {
5141 // For unlogged-in users, load language/variant options from request.
5142 // There's no need to do it for logged-in users: they can set preferences,
5143 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5144 // so don't override user's choice (especially when the user chooses site default).
5145 $variant = MediaWikiServices
::getInstance()->getContentLanguage()->getDefaultVariant();
5146 $this->mOptions
['variant'] = $variant;
5147 $this->mOptions
['language'] = $variant;
5148 $this->mOptionsLoaded
= true;
5152 // Maybe load from the object
5153 if ( !is_null( $this->mOptionOverrides
) ) {
5154 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5155 foreach ( $this->mOptionOverrides
as $key => $value ) {
5156 $this->mOptions
[$key] = $value;
5159 if ( !is_array( $data ) ) {
5160 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5161 // Load from database
5162 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5163 ?
wfGetDB( DB_MASTER
)
5164 : wfGetDB( DB_REPLICA
);
5166 $res = $dbr->select(
5168 [ 'up_property', 'up_value' ],
5169 [ 'up_user' => $this->getId() ],
5173 $this->mOptionOverrides
= [];
5175 foreach ( $res as $row ) {
5176 // Convert '0' to 0. PHP's boolean conversion considers them both
5177 // false, but e.g. JavaScript considers the former as true.
5178 // @todo: T54542 Somehow determine the desired type (string/int/bool)
5179 // and convert all values here.
5180 if ( $row->up_value
=== '0' ) {
5183 $data[$row->up_property
] = $row->up_value
;
5187 foreach ( $data as $property => $value ) {
5188 $this->mOptionOverrides
[$property] = $value;
5189 $this->mOptions
[$property] = $value;
5193 // Replace deprecated language codes
5194 $this->mOptions
['language'] = LanguageCode
::replaceDeprecatedCodes(
5195 $this->mOptions
['language']
5198 $this->mOptionsLoaded
= true;
5200 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5204 * Saves the non-default options for this user, as previously set e.g. via
5205 * setOption(), in the database's "user_properties" (preferences) table.
5206 * Usually used via saveSettings().
5208 protected function saveOptions() {
5209 $this->loadOptions();
5211 // Not using getOptions(), to keep hidden preferences in database
5212 $saveOptions = $this->mOptions
;
5214 // Allow hooks to abort, for instance to save to a global profile.
5215 // Reset options to default state before saving.
5216 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5220 $userId = $this->getId();
5222 $insert_rows = []; // all the new preference rows
5223 foreach ( $saveOptions as $key => $value ) {
5224 // Don't bother storing default values
5225 $defaultOption = self
::getDefaultOption( $key );
5226 if ( ( $defaultOption === null && $value !== false && $value !== null )
5227 ||
$value != $defaultOption
5230 'up_user' => $userId,
5231 'up_property' => $key,
5232 'up_value' => $value,
5237 $dbw = wfGetDB( DB_MASTER
);
5239 $res = $dbw->select( 'user_properties',
5240 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5242 // Find prior rows that need to be removed or updated. These rows will
5243 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5245 foreach ( $res as $row ) {
5246 if ( !isset( $saveOptions[$row->up_property
] )
5247 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5249 $keysDelete[] = $row->up_property
;
5253 if ( count( $keysDelete ) ) {
5254 // Do the DELETE by PRIMARY KEY for prior rows.
5255 // In the past a very large portion of calls to this function are for setting
5256 // 'rememberpassword' for new accounts (a preference that has since been removed).
5257 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5258 // caused gap locks on [max user ID,+infinity) which caused high contention since
5259 // updates would pile up on each other as they are for higher (newer) user IDs.
5260 // It might not be necessary these days, but it shouldn't hurt either.
5261 $dbw->delete( 'user_properties',
5262 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5264 // Insert the new preference rows
5265 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5269 * Return the list of user fields that should be selected to create
5270 * a new user object.
5271 * @deprecated since 1.31, use self::getQueryInfo() instead.
5274 public static function selectFields() {
5275 wfDeprecated( __METHOD__
, '1.31' );
5283 'user_email_authenticated',
5285 'user_email_token_expires',
5286 'user_registration',
5292 * Return the tables, fields, and join conditions to be selected to create
5293 * a new user object.
5295 * @return array With three keys:
5296 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
5297 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
5298 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
5300 public static function getQueryInfo() {
5301 global $wgActorTableSchemaMigrationStage;
5304 'tables' => [ 'user' ],
5312 'user_email_authenticated',
5314 'user_email_token_expires',
5315 'user_registration',
5321 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
5322 // but it does little harm and might be needed for write callers loading a User.
5323 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
5324 $ret['tables']['user_actor'] = 'actor';
5325 $ret['fields'][] = 'user_actor.actor_id';
5326 $ret['joins']['user_actor'] = [
5327 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) ?
'JOIN' : 'LEFT JOIN',
5328 [ 'user_actor.actor_user = user_id' ]
5336 * Factory function for fatal permission-denied errors
5339 * @param string $permission User right required
5342 static function newFatalPermissionDeniedStatus( $permission ) {
5346 foreach ( MediaWikiServices
::getInstance()
5347 ->getPermissionManager()
5348 ->getGroupsWithPermission( $permission ) as $group ) {
5349 $groups[] = UserGroupMembership
::getLink( $group, RequestContext
::getMain(), 'wiki' );
5353 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5356 return Status
::newFatal( 'badaccess-group0' );
5360 * Get a new instance of this user that was loaded from the master via a locking read
5362 * Use this instead of the main context User when updating that user. This avoids races
5363 * where that user was loaded from a replica DB or even the master but without proper locks.
5365 * @return User|null Returns null if the user was not found in the DB
5368 public function getInstanceForUpdate() {
5369 if ( !$this->getId() ) {
5370 return null; // anon
5373 $user = self
::newFromId( $this->getId() );
5374 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5382 * Checks if two user objects point to the same user.
5384 * @since 1.25 ; takes a UserIdentity instead of a User since 1.32
5385 * @param UserIdentity $user
5388 public function equals( UserIdentity
$user ) {
5389 // XXX it's not clear whether central ID providers are supposed to obey this
5390 return $this->getName() === $user->getName();
5394 * Checks if usertalk is allowed
5398 public function isAllowUsertalk() {
5399 return $this->mAllowUsertalk
;