User.php

Go to the documentation of this file.

<?php
use MediaWiki\Auth\AuthenticationRequest;
use MediaWiki\Auth\AuthManager;
use MediaWiki\Block\AbstractBlock;
use MediaWiki\Block\DatabaseBlock;
use MediaWiki\Block\SystemBlock;
use MediaWiki\DAO\WikiAwareEntityTrait;
use MediaWiki\HookContainer\ProtectedHookAccessorTrait;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Permissions\Authority;
use MediaWiki\Permissions\PermissionStatus;
use MediaWiki\Permissions\UserAuthority;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Session\SessionManager;
use MediaWiki\Session\Token;
use MediaWiki\User\UserFactory;
use MediaWiki\User\UserIdentity;
use MediaWiki\User\UserNameUtils;
use MediaWiki\User\UserOptionsLookup;
use Wikimedia\Assert\Assert;
use Wikimedia\Assert\PreconditionException;
use Wikimedia\IPUtils;
use Wikimedia\Rdbms\Database;
use Wikimedia\Rdbms\DBExpectedError;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\ScopedCallback;
 
class User implements Authority, IDBAccessObject, UserIdentity {
    use ProtectedHookAccessorTrait;
    use WikiAwareEntityTrait;
 
    public const TOKEN_LENGTH = 32;
 
    public const INVALID_TOKEN = '*** INVALID ***';
 
    private const VERSION = 16;
 
    public const GETOPTIONS_EXCLUDE_DEFAULTS = UserOptionsLookup::EXCLUDE_DEFAULTS;
 
    public const CHECK_USER_RIGHTS = true;
 
    public const IGNORE_USER_RIGHTS = false;
 
    protected static $mCacheVars = [
        // user table
        'mId',
        'mName',
        'mRealName',
        'mEmail',
        'mTouched',
        'mToken',
        'mEmailAuthenticated',
        'mEmailToken',
        'mEmailTokenExpires',
        'mRegistration',
        'mEditCount',
        // actor table
        'mActorId',
    ];
 
    // Some of these are public, including for use by the UserFactory, but they generally
    // should not be set manually
    // @{
    public $mId;
    public $mName;
    public $mActorId;
    public $mRealName;
 
    public $mEmail;
    public $mTouched;
    protected $mQuickTouched;
    protected $mToken;
    public $mEmailAuthenticated;
    protected $mEmailToken;
    protected $mEmailTokenExpires;
    protected $mRegistration;
    protected $mEditCount;
    // @}
 
    // @{
    protected $mLoadedItems = [];
    // @}
 
    public $mFrom;
 
    protected $mDatePreference;
    public $mBlockedby;
    protected $mHash;
    protected $mBlockreason;
    protected $mGlobalBlock;
    protected $mLocked;
    public $mHideName;
 
    private $mRequest;
 
    public $mBlock;
 
    protected $mAllowUsertalk;
 
    private $mBlockedFromCreateAccount = false;
 
    protected $queryFlagsUsed = self::READ_NORMAL;
 
    private $mThisAsAuthority;
 
    public static $idCacheByName = [];
 
    public function __construct() {
        $this->clearInstanceCache( 'defaults' );
    }
 
    public function getWikiId() {
        return self::LOCAL;
    }
 
    public function __toString() {
        return $this->getName();
    }
 
    public function &__get( $name ) {
        // A shortcut for $mRights deprecation phase
        if ( $name === 'mRights' ) {
            $copy = $this->getRights();
            return $copy;
        } elseif ( $name === 'mOptions' ) {
            wfDeprecated( 'User::$mOptions', '1.35' );
            $options = $this->getOptions();
            return $options;
        } elseif ( !property_exists( $this, $name ) ) {
            // T227688 - do not break $u->foo['bar'] = 1
            wfLogWarning( 'tried to get non-existent property' );
            $this->$name = null;
            return $this->$name;
        } else {
            wfLogWarning( 'tried to get non-visible property' );
            $null = null;
            return $null;
        }
    }
 
    public function __set( $name, $value ) {
        // A shortcut for $mRights deprecation phase, only known legitimate use was for
        // testing purposes, other uses seem bad in principle
        if ( $name === 'mRights' ) {
            MediaWikiServices::getInstance()->getPermissionManager()->overrideUserRightsForTesting(
                $this,
                $value === null ? [] : $value
            );
        } elseif ( $name === 'mOptions' ) {
            wfDeprecated( 'User::$mOptions', '1.35' );
            MediaWikiServices::getInstance()->getUserOptionsManager()->clearUserOptionsCache( $this );
            foreach ( $value as $key => $val ) {
                $this->setOption( $key, $val );
            }
        } elseif ( !property_exists( $this, $name ) ) {
            $this->$name = $value;
        } else {
            wfLogWarning( 'tried to set non-visible property' );
        }
    }
 
    public function __sleep(): array {
        return array_diff(
            array_keys( get_object_vars( $this ) ),
            [
                'mThisAsAuthority' // memoization, will be recreated on demand.
            ]
        );
    }
 
    public function isSafeToLoad() {
        global $wgFullyInitialised;
 
        // The user is safe to load if:
        // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
        // * mLoadedItems === true (already loaded)
        // * mFrom !== 'session' (sessions not involved at all)
 
        return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
            $this->mLoadedItems === true || $this->mFrom !== 'session';
    }
 
    public function load( $flags = self::READ_NORMAL ) {
        global $wgFullyInitialised;
 
        if ( $this->mLoadedItems === true ) {
            return;
        }
 
        // Set it now to avoid infinite recursion in accessors
        $oldLoadedItems = $this->mLoadedItems;
        $this->mLoadedItems = true;
        $this->queryFlagsUsed = $flags;
 
        // If this is called too early, things are likely to break.
        if ( !$wgFullyInitialised && $this->mFrom === 'session' ) {
            \MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
                ->warning( 'User::loadFromSession called before the end of Setup.php', [
                    'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
                ] );
            $this->loadDefaults();
            $this->mLoadedItems = $oldLoadedItems;
            return;
        }
 
        switch ( $this->mFrom ) {
            case 'defaults':
                $this->loadDefaults();
                break;
            case 'id':
                // Make sure this thread sees its own changes, if the ID isn't 0
                if ( $this->mId != 0 ) {
                    $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
                    if ( $lb->hasOrMadeRecentMasterChanges() ) {
                        $flags |= self::READ_LATEST;
                        $this->queryFlagsUsed = $flags;
                    }
                }
 
                $this->loadFromId( $flags );
                break;
            case 'actor':
            case 'name':
                // Make sure this thread sees its own changes
                $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
                if ( $lb->hasOrMadeRecentMasterChanges() ) {
                    $flags |= self::READ_LATEST;
                    $this->queryFlagsUsed = $flags;
                }
 
                list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $flags );
                $row = wfGetDB( $index )->selectRow(
                    'actor',
                    [ 'actor_id', 'actor_user', 'actor_name' ],
                    $this->mFrom === 'name'
                        // make sure to use normalized form of IP for anonymous users
                        ? [ 'actor_name' => IPUtils::sanitizeIP( $this->mName ) ]
                        : [ 'actor_id' => $this->mActorId ],
                    __METHOD__,
                    $options
                );
 
                if ( !$row ) {
                    // Ugh.
                    $this->loadDefaults( $this->mFrom === 'name' ? $this->mName : false );
                } elseif ( $row->actor_user ) {
                    $this->mId = $row->actor_user;
                    $this->loadFromId( $flags );
                } else {
                    $this->loadDefaults( $row->actor_name, $row->actor_id );
                }
                break;
            case 'session':
                if ( !$this->loadFromSession() ) {
                    // Loading from session failed. Load defaults.
                    $this->loadDefaults();
                }
                $this->getHookRunner()->onUserLoadAfterLoadFromSession( $this );
                break;
            default:
                throw new UnexpectedValueException(
                    "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
        }
    }
 
    public function loadFromId( $flags = self::READ_NORMAL ) {
        if ( $this->mId == 0 ) {
            // Anonymous users are not in the database (don't need cache)
            $this->loadDefaults();
            return false;
        }
 
        // Try cache (unless this needs data from the master DB).
        // NOTE: if this thread called saveSettings(), the cache was cleared.
        $latest = DBAccessObjectUtils::hasFlags( $flags, self::READ_LATEST );
        if ( $latest ) {
            if ( !$this->loadFromDatabase( $flags ) ) {
                // Can't load from ID
                return false;
            }
        } else {
            $this->loadFromCache();
        }
 
        $this->mLoadedItems = true;
        $this->queryFlagsUsed = $flags;
 
        return true;
    }
 
    public static function purge( $dbDomain, $userId ) {
        $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
        $key = $cache->makeGlobalKey( 'user', 'id', $dbDomain, $userId );
        $cache->delete( $key );
    }
 
    protected function getCacheKey( WANObjectCache $cache ) {
        $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
 
        return $cache->makeGlobalKey( 'user', 'id', $lbFactory->getLocalDomainID(), $this->mId );
    }
 
    public function getMutableCacheKeys( WANObjectCache $cache ) {
        $id = $this->getId();
 
        return $id ? [ $this->getCacheKey( $cache ) ] : [];
    }
 
    protected function loadFromCache() {
        global $wgFullyInitialised;
 
        $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
        $data = $cache->getWithSetCallback(
            $this->getCacheKey( $cache ),
            $cache::TTL_HOUR,
            function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache, $wgFullyInitialised ) {
                $setOpts += Database::getCacheSetOptions( wfGetDB( DB_REPLICA ) );
                wfDebug( "User: cache miss for user {$this->mId}" );
 
                $this->loadFromDatabase( self::READ_NORMAL );
 
                $data = [];
                foreach ( self::$mCacheVars as $name ) {
                    $data[$name] = $this->$name;
                }
 
                $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX, $this->mTouched ), $ttl );
 
                if ( $wgFullyInitialised ) {
                    $groupMemberships = MediaWikiServices::getInstance()
                        ->getUserGroupManager()
                        ->getUserGroupMemberships( $this, $this->queryFlagsUsed );
 
                    // if a user group membership is about to expire, the cache needs to
                    // expire at that time (T163691)
                    foreach ( $groupMemberships as $ugm ) {
                        if ( $ugm->getExpiry() ) {
                            $secondsUntilExpiry =
                                wfTimestamp( TS_UNIX, $ugm->getExpiry() ) - time();
 
                            if ( $secondsUntilExpiry > 0 && $secondsUntilExpiry < $ttl ) {
                                $ttl = $secondsUntilExpiry;
                            }
                        }
                    }
                }
 
                return $data;
            },
            [ 'pcTTL' => $cache::TTL_PROC_LONG, 'version' => self::VERSION ]
        );
 
        // Restore from cache
        foreach ( self::$mCacheVars as $name ) {
            $this->$name = $data[$name];
        }
 
        return true;
    }
 
    /***************************************************************************/
    // region   newFrom*() static factory methods
    public static function newFromName( $name, $validate = 'valid' ) {
        // Backwards compatibility with strings / false
        $validationLevels = [
            'valid' => UserFactory::RIGOR_VALID,
            'usable' => UserFactory::RIGOR_USABLE,
            'creatable' => UserFactory::RIGOR_CREATABLE
        ];
        if ( $validate === true ) {
            $validate = 'valid';
        }
        if ( $validate === false ) {
            $validation = UserFactory::RIGOR_NONE;
        } elseif ( array_key_exists( $validate, $validationLevels ) ) {
            $validation = $validationLevels[ $validate ];
        } else {
            // Not a recognized value, probably a test for unsupported validation
            // levels, regardless, just pass it along
            $validation = $validate;
        }
 
        $user = MediaWikiServices::getInstance()
            ->getUserFactory()
            ->newFromName( (string)$name, $validation );
 
        // UserFactory returns null instead of false
        if ( $user === null ) {
            $user = false;
        }
        return $user;
    }
 
    public static function newFromId( $id ) {
        return MediaWikiServices::getInstance()
            ->getUserFactory()
            ->newFromId( (int)$id );
    }
 
    public static function newFromActorId( $id ) {
        return MediaWikiServices::getInstance()
            ->getUserFactory()
            ->newFromActorId( (int)$id );
    }
 
    public static function newFromIdentity( UserIdentity $identity ) {
        // Don't use the service if we already have a User object,
        // so that User::newFromIdentity calls don't break things in unit tests.
        if ( $identity instanceof User ) {
            return $identity;
        }
 
        return MediaWikiServices::getInstance()
            ->getUserFactory()
            ->newFromUserIdentity( $identity );
    }
 
    public static function newFromAnyId( $userId, $userName, $actorId, $dbDomain = false ) {
        return MediaWikiServices::getInstance()
            ->getUserFactory()
            ->newFromAnyId( $userId, $userName, $actorId, $dbDomain );
    }
 
    public static function newFromConfirmationCode( $code, $flags = self::READ_NORMAL ) {
        return MediaWikiServices::getInstance()
            ->getUserFactory()
            ->newFromConfirmationCode( (string)$code, $flags );
    }
 
    public static function newFromSession( WebRequest $request = null ) {
        $user = new User;
        $user->mFrom = 'session';
        $user->mRequest = $request;
        return $user;
    }
 
    public static function newFromRow( $row, $data = null ) {
        $user = new User;
        $user->loadFromRow( $row, $data );
        return $user;
    }
 
    public static function newSystemUser( $name, $options = [] ) {
        $options += [
            'validate' => UserNameUtils::RIGOR_VALID,
            'create' => true,
            'steal' => false,
        ];
 
        // Username validation
        // Backwards compatibility with strings / false
        $validationLevels = [
            'valid' => UserNameUtils::RIGOR_VALID,
            'usable' => UserNameUtils::RIGOR_USABLE,
            'creatable' => UserNameUtils::RIGOR_CREATABLE
        ];
        $validate = $options['validate'];
 
        // @phan-suppress-next-line PhanSuspiciousValueComparison
        if ( $validate === false ) {
            $validation = UserNameUtils::RIGOR_NONE;
        } elseif ( array_key_exists( $validate, $validationLevels ) ) {
            $validation = $validationLevels[ $validate ];
        } else {
            // Not a recognized value, probably a test for unsupported validation
            // levels, regardless, just pass it along
            $validation = $validate;
        }
 
        if ( $validation !== UserNameUtils::RIGOR_VALID ) {
            wfDeprecatedMsg(
                __METHOD__ . ' options["validation"] parameter must be omitted or set to "valid".',
                '1.36'
            );
        }
        $services = MediaWikiServices::getInstance();
        $userNameUtils = $services->getUserNameUtils();
 
        $name = $userNameUtils->getCanonical( (string)$name, $validation );
        if ( $name === false ) {
            return null;
        }
 
        $loadBalancer = $services->getDBLoadBalancer();
        $dbr = $loadBalancer->getConnectionRef( DB_REPLICA );
 
        $userQuery = self::getQueryInfo();
        $row = $dbr->selectRow(
            $userQuery['tables'],
            $userQuery['fields'],
            [ 'user_name' => $name ],
            __METHOD__,
            [],
            $userQuery['joins']
        );
        if ( !$row ) {
            // Try the master database...
            $dbw = $loadBalancer->getConnectionRef( DB_MASTER );
            $row = $dbw->selectRow(
                $userQuery['tables'],
                $userQuery['fields'],
                [ 'user_name' => $name ],
                __METHOD__,
                [],
                $userQuery['joins']
            );
        }
 
        if ( !$row ) {
            // No user. Create it?
            if ( !$options['create'] ) {
                // No.
                return null;
            }
 
            // If it's a reserved user that had an anonymous actor created for it at
            // some point, we need special handling.
            if ( !$userNameUtils->isValid( $name ) || $userNameUtils->isUsable( $name ) ) {
                // Not reserved, so just create it.
                return self::createNew( $name, [ 'token' => self::INVALID_TOKEN ] );
            }
 
            // It is reserved. Check for an anonymous actor row.
            $dbw = $loadBalancer->getConnectionRef( DB_MASTER );
            return $dbw->doAtomicSection( __METHOD__, function ( IDatabase $dbw, $fname ) use ( $name ) {
                $row = $dbw->selectRow(
                    'actor',
                    [ 'actor_id' ],
                    [ 'actor_name' => $name, 'actor_user' => null ],
                    $fname,
                    [ 'FOR UPDATE' ]
                );
                if ( !$row ) {
                    // No anonymous actor.
                    return self::createNew( $name, [ 'token' => self::INVALID_TOKEN ] );
                }
 
                // There is an anonymous actor. Delete the actor row so we can create the user,
                // then restore the old actor_id so as to not break existing references.
                // @todo If MediaWiki ever starts using foreign keys for `actor`, this will break things.
                $dbw->delete( 'actor', [ 'actor_id' => $row->actor_id ], $fname );
                $user = self::createNew( $name, [ 'token' => self::INVALID_TOKEN ] );
                $dbw->update(
                    'actor',
                    [ 'actor_id' => $row->actor_id ],
                    [ 'actor_id' => $user->getActorId() ],
                    $fname
                );
                $user->clearInstanceCache( 'id' );
                $user->invalidateCache();
                return $user;
            } );
        }
 
        $user = self::newFromRow( $row );
 
        if ( !$user->isSystemUser() ) {
            // User exists. Steal it?
            if ( !$options['steal'] ) {
                return null;
            }
 
            $services->getAuthManager()->revokeAccessForUser( $name );
 
            $user->invalidateEmail();
            $user->mToken = self::INVALID_TOKEN;
            $user->saveSettings();
            SessionManager::singleton()->preventSessionsForUser( $user->getName() );
        }
 
        return $user;
    }
 
    // endregion -- end of newFrom*() static factory methods
 
    public static function whoIs( $id ) {
        return UserCache::singleton()->getProp( $id, 'name' );
    }
 
    public static function whoIsReal( $id ) {
        return UserCache::singleton()->getProp( $id, 'real_name' );
    }
 
    public static function idFromName( $name, $flags = self::READ_NORMAL ) {
        // Don't explode on self::$idCacheByName[$name] if $name is not a string but e.g. a User object
        $name = (string)$name;
        $nt = Title::makeTitleSafe( NS_USER, $name );
        if ( $nt === null ) {
            // Illegal name
            return null;
        }
 
        if ( !( $flags & self::READ_LATEST ) && array_key_exists( $name, self::$idCacheByName ) ) {
            return self::$idCacheByName[$name] === null ? null : (int)self::$idCacheByName[$name];
        }
 
        list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $flags );
        $db = wfGetDB( $index );
 
        $s = $db->selectRow(
            'user',
            [ 'user_id' ],
            [ 'user_name' => $nt->getText() ],
            __METHOD__,
            $options
        );
 
        if ( $s === false ) {
            $result = null;
        } else {
            $result = (int)$s->user_id;
        }
 
        if ( count( self::$idCacheByName ) >= 1000 ) {
            self::$idCacheByName = [];
        }
 
        self::$idCacheByName[$name] = $result;
 
        return $result;
    }
 
    public static function resetIdByNameCache() {
        self::$idCacheByName = [];
    }
 
    public static function isIP( $name ) {
        return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
            || IPUtils::isIPv6( $name );
    }
 
    public function isIPRange() {
        return IPUtils::isValidRange( $this->mName );
    }
 
    public static function isValidUserName( $name ) {
        return MediaWikiServices::getInstance()->getUserNameUtils()->isValid( $name );
    }
 
    public static function isUsableName( $name ) {
        return MediaWikiServices::getInstance()->getUserNameUtils()->isUsable( $name );
    }
 
    public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
        if ( $groups === [] ) {
            return UserArrayFromResult::newFromIDs( [] );
        }
 
        $groups = array_unique( (array)$groups );
        $limit = min( 5000, $limit );
 
        $conds = [ 'ug_group' => $groups ];
        if ( $after !== null ) {
            $conds[] = 'ug_user > ' . (int)$after;
        }
 
        $dbr = wfGetDB( DB_REPLICA );
        $ids = $dbr->selectFieldValues(
            'user_groups',
            'ug_user',
            $conds,
            __METHOD__,
            [
                'DISTINCT' => true,
                'ORDER BY' => 'ug_user',
                'LIMIT' => $limit,
            ]
        ) ?: [];
        return UserArray::newFromIDs( $ids );
    }
 
    public static function isCreatableName( $name ) {
        return MediaWikiServices::getInstance()->getUserNameUtils()->isCreatable( $name );
    }
 
    public function isValidPassword( $password ) {
        // simple boolean wrapper for checkPasswordValidity
        return $this->checkPasswordValidity( $password )->isGood();
    }
 
    public function checkPasswordValidity( $password ) {
        global $wgPasswordPolicy;
 
        $upp = new UserPasswordPolicy(
            $wgPasswordPolicy['policies'],
            $wgPasswordPolicy['checks']
        );
 
        $status = Status::newGood( [] );
        $result = false; // init $result to false for the internal checks
 
        if ( !$this->getHookRunner()->onIsValidPassword( $password, $result, $this ) ) {
            $status->error( $result );
            return $status;
        }
 
        if ( $result === false ) {
            $status->merge( $upp->checkUserPassword( $this, $password ), true );
            return $status;
        }
 
        if ( $result === true ) {
            return $status;
        }
 
        $status->error( $result );
        return $status; // the isValidPassword hook set a string $result and returned true
    }
 
    public static function getCanonicalName( $name, $validate = 'valid' ) {
        // Backwards compatibility with strings / false
        $validationLevels = [
            'valid' => UserNameUtils::RIGOR_VALID,
            'usable' => UserNameUtils::RIGOR_USABLE,
            'creatable' => UserNameUtils::RIGOR_CREATABLE
        ];
 
        if ( $validate === false ) {
            $validation = UserNameUtils::RIGOR_NONE;
        } elseif ( array_key_exists( $validate, $validationLevels ) ) {
            $validation = $validationLevels[ $validate ];
        } else {
            // Not a recognized value, probably a test for unsupported validation
            // levels, regardless, just pass it along
            $validation = $validate;
        }
 
        return MediaWikiServices::getInstance()
            ->getUserNameUtils()
            ->getCanonical( (string)$name, $validation );
    }
 
    public function loadDefaults( $name = false, $actorId = null ) {
        $this->mId = 0;
        $this->mName = $name;
        $this->mActorId = $actorId;
        $this->mRealName = '';
        $this->mEmail = '';
 
        $loggedOut = $this->mRequest && !defined( 'MW_NO_SESSION' )
            ? $this->mRequest->getSession()->getLoggedOutTimestamp() : 0;
        if ( $loggedOut !== 0 ) {
            $this->mTouched = wfTimestamp( TS_MW, $loggedOut );
        } else {
            $this->mTouched = '1'; # Allow any pages to be cached
        }
 
        $this->mToken = null; // Don't run cryptographic functions till we need a token
        $this->mEmailAuthenticated = null;
        $this->mEmailToken = '';
        $this->mEmailTokenExpires = null;
        $this->mRegistration = wfTimestamp( TS_MW );
 
        $this->getHookRunner()->onUserLoadDefaults( $this, $name );
    }
 
    public function isItemLoaded( $item, $all = 'all' ) {
        return ( $this->mLoadedItems === true && $all === 'all' ) ||
            ( isset( $this->mLoadedItems[$item] ) && $this->mLoadedItems[$item] === true );
    }
 
    public function setItemLoaded( $item ) {
        if ( is_array( $this->mLoadedItems ) ) {
            $this->mLoadedItems[$item] = true;
        }
    }
 
    private function loadFromSession() {
        // MediaWiki\Session\Session already did the necessary authentication of the user
        // returned here, so just use it if applicable.
        $session = $this->getRequest()->getSession();
        $user = $session->getUser();
        if ( $user->isRegistered() ) {
            $this->loadFromUserObject( $user );
 
            // Other code expects these to be set in the session, so set them.
            $session->set( 'wsUserID', $this->getId() );
            $session->set( 'wsUserName', $this->getName() );
            $session->set( 'wsToken', $this->getToken() );
 
            return true;
        }
 
        return false;
    }
 
    public function loadFromDatabase( $flags = self::READ_LATEST ) {
        // Paranoia
        $this->mId = intval( $this->mId );
 
        if ( !$this->mId ) {
            // Anonymous users are not in the database
            $this->loadDefaults();
            return false;
        }
 
        list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $flags );
        $db = wfGetDB( $index );
 
        $userQuery = self::getQueryInfo();
        $s = $db->selectRow(
            $userQuery['tables'],
            $userQuery['fields'],
            [ 'user_id' => $this->mId ],
            __METHOD__,
            $options,
            $userQuery['joins']
        );
 
        $this->queryFlagsUsed = $flags;
        $this->getHookRunner()->onUserLoadFromDatabase( $this, $s );
 
        if ( $s !== false ) {
            // Initialise user table data
            $this->loadFromRow( $s );
            $this->getEditCount(); // revalidation for nulls
            return true;
        }
 
        // Invalid user_id
        $this->mId = 0;
        $this->loadDefaults( 'Unknown user' );
 
        return false;
    }
 
    protected function loadFromRow( $row, $data = null ) {
        if ( !is_object( $row ) ) {
            throw new InvalidArgumentException( '$row must be an object' );
        }
 
        $all = true;
 
        if ( isset( $row->actor_id ) ) {
            $this->mActorId = (int)$row->actor_id;
            if ( $this->mActorId !== 0 ) {
                $this->mFrom = 'actor';
            }
            $this->setItemLoaded( 'actor' );
        } else {
            $all = false;
        }
 
        if ( isset( $row->user_name ) && $row->user_name !== '' ) {
            $this->mName = $row->user_name;
            $this->mFrom = 'name';
            $this->setItemLoaded( 'name' );
        } else {
            $all = false;
        }
 
        if ( isset( $row->user_real_name ) ) {
            $this->mRealName = $row->user_real_name;
            $this->setItemLoaded( 'realname' );
        } else {
            $all = false;
        }
 
        if ( isset( $row->user_id ) ) {
            $this->mId = intval( $row->user_id );
            if ( $this->mId !== 0 ) {
                $this->mFrom = 'id';
            }
            $this->setItemLoaded( 'id' );
        } else {
            $all = false;
        }
 
        if ( isset( $row->user_id ) && isset( $row->user_name ) && $row->user_name !== '' ) {
            self::$idCacheByName[$row->user_name] = $row->user_id;
        }
 
        if ( isset( $row->user_editcount ) ) {
            $this->mEditCount = $row->user_editcount;
        } else {
            $all = false;
        }
 
        if ( isset( $row->user_touched ) ) {
            $this->mTouched = wfTimestamp( TS_MW, $row->user_touched );
        } else {
            $all = false;
        }
 
        if ( isset( $row->user_token ) ) {
            // The definition for the column is binary(32), so trim the NULs
            // that appends. The previous definition was char(32), so trim
            // spaces too.
            $this->mToken = rtrim( $row->user_token, " \0" );
            if ( $this->mToken === '' ) {
                $this->mToken = null;
            }
        } else {
            $all = false;
        }
 
        if ( isset( $row->user_email ) ) {
            $this->mEmail = $row->user_email;
            $this->mEmailAuthenticated = wfTimestampOrNull( TS_MW, $row->user_email_authenticated );
            $this->mEmailToken = $row->user_email_token;
            $this->mEmailTokenExpires = wfTimestampOrNull( TS_MW, $row->user_email_token_expires );
            $this->mRegistration = wfTimestampOrNull( TS_MW, $row->user_registration );
        } else {
            $all = false;
        }
 
        if ( $all ) {
            $this->mLoadedItems = true;
        }
 
        if ( is_array( $data ) ) {
 
            if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
                MediaWikiServices::getInstance()
                    ->getUserGroupManager()
                    ->loadGroupMembershipsFromArray(
                        $this,
                        $data['user_groups'],
                        $this->queryFlagsUsed
                    );
            }
            if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
                MediaWikiServices::getInstance()
                    ->getUserOptionsManager()
                    ->loadUserOptions( $this, $this->queryFlagsUsed, $data['user_properties'] );
            }
        }
    }
 
    protected function loadFromUserObject( $user ) {
        $user->load();
        foreach ( self::$mCacheVars as $var ) {
            $this->$var = $user->$var;
        }
    }
 
    public function addAutopromoteOnceGroups( $event ) {
        return MediaWikiServices::getInstance()
            ->getUserGroupManager()
            ->addUserToAutopromoteOnceGroups( $this, $event );
    }
 
    protected function makeUpdateConditions( IDatabase $db, array $conditions ) {
        if ( $this->mTouched ) {
            // CAS check: only update if the row wasn't changed sicne it was loaded.
            $conditions['user_touched'] = $db->timestamp( $this->mTouched );
        }
 
        return $conditions;
    }
 
    public function checkAndSetTouched() {
        $this->load();
 
        if ( !$this->mId ) {
            return false; // anon
        }
 
        // Get a new user_touched that is higher than the old one
        $newTouched = $this->newTouchedTimestamp();
 
        $dbw = wfGetDB( DB_MASTER );
        $dbw->update( 'user',
            [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
            $this->makeUpdateConditions( $dbw, [
                'user_id' => $this->mId,
            ] ),
            __METHOD__
        );
        $success = ( $dbw->affectedRows() > 0 );
 
        if ( $success ) {
            $this->mTouched = $newTouched;
            $this->clearSharedCache( 'changed' );
        } else {
            // Clears on failure too since that is desired if the cache is stale
            $this->clearSharedCache( 'refresh' );
        }
 
        return $success;
    }
 
    public function clearInstanceCache( $reloadFrom = false ) {
        global $wgFullyInitialised;
 
        $this->mDatePreference = null;
        $this->mBlockedby = -1; # Unset
        $this->mHash = false;
        $this->mEditCount = null;
        $this->mThisAsAuthority = null;
 
        if ( $wgFullyInitialised && $this->mFrom ) {
            $services = MediaWikiServices::getInstance();
            $services->getPermissionManager()->invalidateUsersRightsCache( $this );
            $services->getUserOptionsManager()->clearUserOptionsCache( $this );
            $services->getTalkPageNotificationManager()->clearInstanceCache( $this );
            $services->getUserGroupManager()->clearCache( $this );
            $services->getUserEditTracker()->clearUserEditCache( $this );
        }
 
        if ( $reloadFrom ) {
            $this->mLoadedItems = [];
            $this->mFrom = $reloadFrom;
        }
    }
 
    public static function getDefaultOptions() {
        return MediaWikiServices::getInstance()
            ->getUserOptionsLookup()
            ->getDefaultOptions();
    }
 
    public static function getDefaultOption( $opt ) {
        return MediaWikiServices::getInstance()
            ->getUserOptionsLookup()
            ->getDefaultOption( $opt );
    }
 
    private function getBlockedStatus( $fromReplica = true, $disableIpBlockExemptChecking = false ) {
        if ( $this->mBlockedby != -1 ) {
            return;
        }
 
        wfDebug( __METHOD__ . ": checking blocked status for " . $this->getName() );
 
        // Initialize data...
        // Otherwise something ends up stomping on $this->mBlockedby when
        // things get lazy-loaded later, causing false positive block hits
        // due to -1 !== 0. Probably session-related... Nothing should be
        // overwriting mBlockedby, surely?
        $this->load();
 
        // TODO: Block checking shouldn't really be done from the User object. Block
        // checking can involve checking for IP blocks, cookie blocks, and/or XFF blocks,
        // which need more knowledge of the request context than the User should have.
        // Since we do currently check blocks from the User, we have to do the following
        // here:
        // - Check if this is the user associated with the main request
        // - If so, pass the relevant request information to the block manager
        $request = null;
        if ( $this->isGlobalSessionUser() ) {
            // This is the global user, so we need to pass the request
            $request = $this->getRequest();
        }
 
        $block = MediaWikiServices::getInstance()->getBlockManager()->getUserBlock(
            $this,
            $request,
            $fromReplica,
            $disableIpBlockExemptChecking
        );
 
        if ( $block ) {
            $this->mBlock = $block;
            $this->mBlockedby = $block->getByName();
            $this->mBlockreason = $block->getReason();
            $this->mHideName = $block->getHideName();
            $this->mAllowUsertalk = $block->isUsertalkEditAllowed();
        } else {
            $this->mBlock = null;
            $this->mBlockedby = '';
            $this->mBlockreason = '';
            $this->mHideName = 0;
            $this->mAllowUsertalk = false;
        }
    }
 
    public function isPingLimitable() {
        global $wgRateLimitsExcludedIPs;
        if ( IPUtils::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
            // No other good way currently to disable rate limits
            // for specific IPs. :P
            // But this is a crappy hack and should die.
            return false;
        }
        return !$this->isAllowed( 'noratelimit' );
    }
 
    public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
        $logger = \MediaWiki\Logger\LoggerFactory::getInstance( 'ratelimit' );
 
        // Call the 'PingLimiter' hook
        $result = false;
        if ( !$this->getHookRunner()->onPingLimiter( $this, $action, $result, $incrBy ) ) {
            return $result;
        }
 
        global $wgRateLimits;
        if ( !isset( $wgRateLimits[$action] ) ) {
            return false;
        }
 
        $limits = array_merge(
            [ '&can-bypass' => true ],
            $wgRateLimits[$action]
        );
 
        // Some groups shouldn't trigger the ping limiter, ever
        if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
            return false;
        }
 
        $logger->debug( __METHOD__ . ": limiting $action rate for {$this->getName()}" );
 
        $keys = [];
        $id = $this->getId();
        $isNewbie = $this->isNewbie();
        $cache = ObjectCache::getLocalClusterInstance();
 
        if ( $id == 0 ) {
            // "shared anon" limit, for all anons combined
            if ( isset( $limits['anon'] ) ) {
                $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
            }
        } else {
            // "global per name" limit, across sites
            if ( isset( $limits['user-global'] ) ) {
                $lookup = CentralIdLookup::factoryNonLocal();
 
                $centralId = $lookup
                    ? $lookup->centralIdFromLocalUser( $this, CentralIdLookup::AUDIENCE_RAW )
                    : 0;
 
                if ( $centralId ) {
                    // We don't have proper realms, use provider ID.
                    $realm = $lookup->getProviderId();
 
                    $globalKey = $cache->makeGlobalKey( 'limiter', $action, 'user-global',
                        $realm, $centralId );
                } else {
                    // Fall back to a local key for a local ID
                    $globalKey = $cache->makeKey( 'limiter', $action, 'user-global',
                        'local', $id );
                }
                $keys[$globalKey] = $limits['user-global'];
            }
        }
 
        if ( $isNewbie ) {
            // "per ip" limit for anons and newbie users
            if ( isset( $limits['ip'] ) ) {
                $ip = $this->getRequest()->getIP();
                $keys[$cache->makeGlobalKey( 'limiter', $action, 'ip', $ip )] = $limits['ip'];
            }
            // "per subnet" limit for anons and newbie users
            if ( isset( $limits['subnet'] ) ) {
                $ip = $this->getRequest()->getIP();
                $subnet = IPUtils::getSubnet( $ip );
                if ( $subnet !== false ) {
                    $keys[$cache->makeGlobalKey( 'limiter', $action, 'subnet', $subnet )] = $limits['subnet'];
                }
            }
        }
 
        // determine the "per user account" limit
        $userLimit = false;
        if ( $id !== 0 && isset( $limits['user'] ) ) {
            // default limit for logged-in users
            $userLimit = $limits['user'];
        }
        // limits for newbie logged-in users (overrides all the normal user limits)
        if ( $id !== 0 && $isNewbie && isset( $limits['newbie'] ) ) {
            $userLimit = $limits['newbie'];
        } else {
            // Check for group-specific limits
            // If more than one group applies, use the highest allowance (if higher than the default)
            foreach ( $this->getGroups() as $group ) {
                if ( isset( $limits[$group] ) ) {
                    if ( $userLimit === false
                        || $limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
                    ) {
                        $userLimit = $limits[$group];
                    }
                }
            }
        }
 
        // Set the user limit key
        if ( $userLimit !== false ) {
            // phan is confused because &can-bypass's value is a bool, so it assumes
            // that $userLimit is also a bool here.
            // @phan-suppress-next-line PhanTypeInvalidExpressionArrayDestructuring
            list( $max, $period ) = $userLimit;
            $logger->debug( __METHOD__ . ": effective user limit: $max in {$period}s" );
            $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
        }
 
        // ip-based limits for all ping-limitable users
        if ( isset( $limits['ip-all'] ) ) {
            $ip = $this->getRequest()->getIP();
            // ignore if user limit is more permissive
            if ( $isNewbie || $userLimit === false
                || $limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
                $keys[$cache->makeGlobalKey( 'limiter', $action, 'ip-all', $ip )] = $limits['ip-all'];
            }
        }
 
        // subnet-based limits for all ping-limitable users
        if ( isset( $limits['subnet-all'] ) ) {
            $ip = $this->getRequest()->getIP();
            $subnet = IPUtils::getSubnet( $ip );
            if ( $subnet !== false ) {
                // ignore if user limit is more permissive
                if ( $isNewbie || $userLimit === false
                    || $limits['ip-all'][0] / $limits['ip-all'][1]
                    > $userLimit[0] / $userLimit[1] ) {
                    $keys[$cache->makeGlobalKey( 'limiter', $action, 'subnet-all', $subnet )] = $limits['subnet-all'];
                }
            }
        }
 
        // XXX: We may want to use $cache->getCurrentTime() here, but that would make it
        //      harder to test for T246991. Also $cache->getCurrentTime() is documented
        //      as being for testing only, so it apparently should not be called here.
        $now = MWTimestamp::time();
        $clockFudge = 3; // avoid log spam when a clock is slightly off
 
        $triggered = false;
        foreach ( $keys as $key => $limit ) {
 
            // Do the update in a merge callback, for atomicity.
            // To use merge(), we need to explicitly track the desired expiry timestamp.
            // This tracking was introduced to investigate T246991. Once it is no longer needed,
            // we could go back to incrWithInit(), though that has more potential for race
            // conditions between the get() and incrWithInit() calls.
            $cache->merge(
                $key,
                function ( $cache, $key, $data, &$expiry )
                    use ( $action, $logger, &$triggered, $now, $clockFudge, $limit, $incrBy )
                {
                    // phan is confused because &can-bypass's value is a bool, so it assumes
                    // that $userLimit is also a bool here.
                    // @phan-suppress-next-line PhanTypeInvalidExpressionArrayDestructuring
                    list( $max, $period ) = $limit;
 
                    $expiry = $now + (int)$period;
                    $count = 0;
 
                    // Already pinged?
                    if ( $data ) {
                        // NOTE: in order to investigate T246991, we write the expiry time
                        //       into the payload, along with the count.
                        $fields = explode( '|', $data );
                        $storedCount = (int)( $fields[0] ?? 0 );
                        $storedExpiry = (int)( $fields[1] ?? PHP_INT_MAX );
 
                        // Found a stale entry. This should not happen!
                        if ( $storedExpiry < ( $now + $clockFudge ) ) {
                            $logger->info(
                                'User::pingLimiter: '
                                . 'Stale rate limit entry, cache key failed to expire (T246991)',
                                [
                                    'action' => $action,
                                    'user' => $this->getName(),
                                    'limit' => $max,
                                    'period' => $period,
                                    'count' => $storedCount,
                                    'key' => $key,
                                    'expiry' => MWTimestamp::convert( TS_DB, $storedExpiry ),
                                ]
                            );
                        } else {
                            // NOTE: We'll keep the original expiry when bumping counters,
                            //       resulting in a kind of fixed-window throttle.
                            $expiry = min( $storedExpiry, $now + (int)$period );
                            $count = $storedCount;
                        }
                    }
 
                    // Limit exceeded!
                    if ( $count >= $max ) {
                        if ( !$triggered ) {
                            $logger->info(
                                'User::pingLimiter: User tripped rate limit',
                                [
                                    'action' => $action,
                                    'user' => $this->getName(),
                                    'ip' => $this->getRequest()->getIP(),
                                    'limit' => $max,
                                    'period' => $period,
                                    'count' => $count,
                                    'key' => $key
                                ]
                            );
                        }
 
                        $triggered = true;
                    }
 
                    $count += $incrBy;
                    $data = "$count|$expiry";
                    return $data;
                }
            );
        }
 
        return $triggered;
    }
 
    public function isBlocked( $fromReplica = true ) {
        return $this->getBlock( $fromReplica ) instanceof AbstractBlock;
    }
 
    public function getBlock( $fromReplica = true, $disableIpBlockExemptChecking = false ) {
        $this->getBlockedStatus( $fromReplica, $disableIpBlockExemptChecking );
        return $this->mBlock instanceof AbstractBlock ? $this->mBlock : null;
    }
 
    public function isBlockedFrom( $title, $fromReplica = false ) {
        return MediaWikiServices::getInstance()->getPermissionManager()
            ->isBlockedFrom( $this, $title, $fromReplica );
    }
 
    public function blockedBy() {
        $this->getBlockedStatus();
        return $this->mBlockedby;
    }
 
    public function blockedFor() {
        $this->getBlockedStatus();
        return $this->mBlockreason;
    }
 
    public function getBlockId() {
        $this->getBlockedStatus();
        return ( $this->mBlock ? $this->mBlock->getId() : false );
    }
 
    public function isBlockedGlobally( $ip = '' ) {
        return $this->getGlobalBlock( $ip ) instanceof AbstractBlock;
    }
 
    public function getGlobalBlock( $ip = '' ) {
        if ( $this->mGlobalBlock !== null ) {
            return $this->mGlobalBlock ?: null;
        }
        // User is already an IP?
        if ( IPUtils::isIPAddress( $this->getName() ) ) {
            $ip = $this->getName();
        } elseif ( !$ip ) {
            $ip = $this->getRequest()->getIP();
        }
        $blocked = false;
        $block = null;
        $this->getHookRunner()->onUserIsBlockedGlobally( $this, $ip, $blocked, $block );
 
        if ( $blocked && $block === null ) {
            // back-compat: UserIsBlockedGlobally didn't have $block param first
            $block = new SystemBlock( [
                'address' => $ip,
                'systemBlock' => 'global-block'
            ] );
        }
 
        $this->mGlobalBlock = $blocked ? $block : false;
        return $this->mGlobalBlock ?: null;
    }
 
    public function isLocked() {
        if ( $this->mLocked !== null ) {
            return $this->mLocked;
        }
        // Reset for hook
        $this->mLocked = false;
        $this->getHookRunner()->onUserIsLocked( $this, $this->mLocked );
        return $this->mLocked;
    }
 
    public function isHidden() {
        if ( $this->mHideName !== null ) {
            return (bool)$this->mHideName;
        }
        $this->getBlockedStatus();
        return (bool)$this->mHideName;
    }
 
    public function getId() : int {
        if ( $this->mId === null && $this->mName !== null &&
            ( self::isIP( $this->mName ) || ExternalUserNames::isExternal( $this->mName ) )
        ) {
            // Special case, we know the user is anonymous
            // Note that "external" users are "local" (they have an actor ID that is relative to
            // the local wiki).
            return 0;
        }
 
        if ( !$this->isItemLoaded( 'id' ) ) {
            // Don't load if this was initialized from an ID
            $this->load();
        }
 
        return (int)$this->mId;
    }
 
    public function getUserId( $wikiId = self::LOCAL ) : int {
        $this->assertWiki( $wikiId );
        return $this->getId();
    }
 
    public function setId( $v ) {
        $this->mId = $v;
        $this->clearInstanceCache( 'id' );
    }
 
    public function getName() : string {
        if ( $this->isItemLoaded( 'name', 'only' ) ) {
            // Special case optimisation
            return $this->mName;
        }
 
        $this->load();
        if ( $this->mName === false ) {
            // Clean up IPs
            $this->mName = IPUtils::sanitizeIP( $this->getRequest()->getIP() );
        }
 
        return $this->mName;
    }
 
    public function setName( $str ) {
        $this->load();
        $this->mName = $str;
    }
 
    public function getActorId( $dbwOrWikiId = self::LOCAL ) : int {
        if ( $dbwOrWikiId instanceof IDatabase ) {
            wfDeprecatedMsg( 'Passing parameter of type IDatabase', '1.36' );
        } else {
            $this->assertWiki( $dbwOrWikiId );
        }
 
        if ( !$this->isItemLoaded( 'actor' ) ) {
            $this->load();
        }
 
        if ( !$this->mActorId && $dbwOrWikiId instanceof IDatabase ) {
            MediaWikiServices::getInstance()
                ->getActorStoreFactory()
                ->getActorNormalization( $dbwOrWikiId->getDomainID() )
                ->acquireActorId( $this, $dbwOrWikiId );
            // acquireActorId will call setActorId on $this
            Assert::postcondition(
                $this->mActorId !== null,
                "Failed to acquire actor ID for user id {$this->mId} name {$this->mName}"
            );
        }
 
        return (int)$this->mActorId;
    }
 
    public function setActorId( int $actorId ) {
        $this->mActorId = $actorId;
        $this->invalidateCache();
        $this->setItemLoaded( 'actor' );
    }
 
    public function getTitleKey() {
        return str_replace( ' ', '_', $this->getName() );
    }
 
    public function getNewtalk() {
        wfDeprecated( __METHOD__, '1.35' );
        return MediaWikiServices::getInstance()
            ->getTalkPageNotificationManager()
            ->userHasNewMessages( $this );
    }
 
    public function getNewMessageLinks() {
        wfDeprecated( __METHOD__, '1.35' );
        $talks = [];
        if ( !$this->getHookRunner()->onUserRetrieveNewTalks( $this, $talks ) ) {
            return $talks;
        }
 
        $services = MediaWikiServices::getInstance();
        $userHasNewMessages = $services->getTalkPageNotificationManager()
            ->userHasNewMessages( $this );
        if ( !$userHasNewMessages ) {
            return [];
        }
        $utp = $this->getTalkPage();
        $timestamp = $services->getTalkPageNotificationManager()
            ->getLatestSeenMessageTimestamp( $this );
        $rev = null;
        if ( $timestamp ) {
            $revRecord = $services->getRevisionLookup()
                ->getRevisionByTimestamp( $utp, $timestamp );
            if ( $revRecord ) {
                $rev = new Revision( $revRecord );
            }
        }
        return [
            [
                'wiki' => WikiMap::getCurrentWikiId(),
                'link' => $utp->getLocalURL(),
                'rev' => $rev
            ]
        ];
    }
 
    public function getNewMessageRevisionId() {
        wfDeprecated( __METHOD__, '1.35' );
        $newMessageRevisionId = null;
        $newMessageLinks = $this->getNewMessageLinks();
 
        // Note: getNewMessageLinks() never returns more than a single link
        // and it is always for the same wiki, but we double-check here in
        // case that changes some time in the future.
        if ( $newMessageLinks && count( $newMessageLinks ) === 1
            && WikiMap::isCurrentWikiId( $newMessageLinks[0]['wiki'] )
            && $newMessageLinks[0]['rev']
        ) {
            $newMessageRevision = $newMessageLinks[0]['rev'];
            $newMessageRevisionId = $newMessageRevision->getId();
        }
 
        return $newMessageRevisionId;
    }
 
    public function setNewtalk( $val, $curRev = null ) {
        wfDeprecated( __METHOD__, '1.35' );
        if ( $curRev && $curRev instanceof Revision ) {
            $curRev = $curRev->getRevisionRecord();
        }
        if ( $val ) {
            MediaWikiServices::getInstance()
                ->getTalkPageNotificationManager()
                ->setUserHasNewMessages( $this, $curRev );
        } else {
            MediaWikiServices::getInstance()
                ->getTalkPageNotificationManager()
                ->removeUserHasNewMessages( $this );
        }
    }
 
    private function newTouchedTimestamp() {
        $time = time();
        if ( $this->mTouched ) {
            $time = max( $time, wfTimestamp( TS_UNIX, $this->mTouched ) + 1 );
        }
 
        return wfTimestamp( TS_MW, $time );
    }
 
    public function clearSharedCache( $mode = 'refresh' ) {
        if ( !$this->getId() ) {
            return;
        }
 
        $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
        $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
        $key = $this->getCacheKey( $cache );
 
        if ( $mode === 'refresh' ) {
            $cache->delete( $key, 1 ); // low tombstone/"hold-off" TTL
        } else {
            $lb->getConnectionRef( DB_MASTER )->onTransactionPreCommitOrIdle(
                static function () use ( $cache, $key ) {
                    $cache->delete( $key );
                },
                __METHOD__
            );
        }
    }
 
    public function invalidateCache() {
        $this->touch();
        $this->clearSharedCache( 'changed' );
    }
 
    public function touch() {
        $id = $this->getId();
        if ( $id ) {
            $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
            $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
            $cache->touchCheckKey( $key );
            $this->mQuickTouched = null;
        }
    }
 
    public function validateCache( $timestamp ) {
        return ( $timestamp >= $this->getTouched() );
    }
 
    public function getTouched() {
        $this->load();
 
        if ( $this->mId ) {
            if ( $this->mQuickTouched === null ) {
                $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
                $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId );
 
                $this->mQuickTouched = wfTimestamp( TS_MW, $cache->getCheckKeyTime( $key ) );
            }
 
            return max( $this->mTouched, $this->mQuickTouched );
        }
 
        return $this->mTouched;
    }
 
    public function getDBTouched() {
        $this->load();
 
        return $this->mTouched;
    }
 
    public function changeAuthenticationData( array $data ) {
        $manager = MediaWikiServices::getInstance()->getAuthManager();
        $reqs = $manager->getAuthenticationRequests( AuthManager::ACTION_CHANGE, $this );
        $reqs = AuthenticationRequest::loadRequestsFromSubmission( $reqs, $data );
 
        $status = Status::newGood( 'ignored' );
        foreach ( $reqs as $req ) {
            $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
        }
        if ( $status->getValue() === 'ignored' ) {
            $status->warning( 'authenticationdatachange-ignored' );
        }
 
        if ( $status->isGood() ) {
            foreach ( $reqs as $req ) {
                $manager->changeAuthenticationData( $req );
            }
        }
        return $status;
    }
 
    public function getToken( $forceCreation = true ) {
        global $wgAuthenticationTokenVersion;
 
        $this->load();
        if ( !$this->mToken && $forceCreation ) {
            $this->setToken();
        }
 
        if ( !$this->mToken ) {
            // The user doesn't have a token, return null to indicate that.
            return null;
        }
 
        if ( $this->mToken === self::INVALID_TOKEN ) {
            // We return a random value here so existing token checks are very
            // likely to fail.
            return MWCryptRand::generateHex( self::TOKEN_LENGTH );
        }
 
        if ( $wgAuthenticationTokenVersion === null ) {
            // $wgAuthenticationTokenVersion not in use, so return the raw secret
            return $this->mToken;
        }
 
        // $wgAuthenticationTokenVersion in use, so hmac it.
        $ret = MWCryptHash::hmac( $wgAuthenticationTokenVersion, $this->mToken, false );
 
        // The raw hash can be overly long. Shorten it up.
        $len = max( 32, self::TOKEN_LENGTH );
        if ( strlen( $ret ) < $len ) {
            // Should never happen, even md5 is 128 bits
            throw new \UnexpectedValueException( 'Hmac returned less than 128 bits' );
        }
 
        return substr( $ret, -$len );
    }
 
    public function setToken( $token = false ) {
        $this->load();
        if ( $this->mToken === self::INVALID_TOKEN ) {
            \MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
                ->debug( __METHOD__ . ": Ignoring attempt to set token for system user \"$this\"" );
        } elseif ( !$token ) {
            $this->mToken = MWCryptRand::generateHex( self::TOKEN_LENGTH );
        } else {
            $this->mToken = $token;
        }
    }
 
    public function getEmail() {
        $this->load();
        $this->getHookRunner()->onUserGetEmail( $this, $this->mEmail );
        return $this->mEmail;
    }
 
    public function getEmailAuthenticationTimestamp() {
        $this->load();
        $this->getHookRunner()->onUserGetEmailAuthenticationTimestamp(
            $this, $this->mEmailAuthenticated );
        return $this->mEmailAuthenticated;
    }
 
    public function setEmail( $str ) {
        $this->load();
        if ( $str == $this->getEmail() ) {
            return;
        }
        $this->invalidateEmail();
        $this->mEmail = $str;
        $this->getHookRunner()->onUserSetEmail( $this, $this->mEmail );
    }
 
    public function setEmailWithConfirmation( $str ) {
        global $wgEnableEmail, $wgEmailAuthentication;
 
        if ( !$wgEnableEmail ) {
            return Status::newFatal( 'emaildisabled' );
        }
 
        $oldaddr = $this->getEmail();
        if ( $str === $oldaddr ) {
            return Status::newGood( true );
        }
 
        $type = $oldaddr != '' ? 'changed' : 'set';
        $notificationResult = null;
 
        if ( $wgEmailAuthentication && $type === 'changed' ) {
            // Send the user an email notifying the user of the change in registered
            // email address on their previous email address
            $change = $str != '' ? 'changed' : 'removed';
            $notificationResult = $this->sendMail(
                wfMessage( 'notificationemail_subject_' . $change )->text(),
                wfMessage( 'notificationemail_body_' . $change,
                    $this->getRequest()->getIP(),
                    $this->getName(),
                    $str )->text()
            );
        }
 
        $this->setEmail( $str );
 
        if ( $str !== '' && $wgEmailAuthentication ) {
            // Send a confirmation request to the new address if needed
            $result = $this->sendConfirmationMail( $type );
 
            if ( $notificationResult !== null ) {
                $result->merge( $notificationResult );
            }
 
            if ( $result->isGood() ) {
                // Say to the caller that a confirmation and notification mail has been sent
                $result->value = 'eauth';
            }
        } else {
            $result = Status::newGood( true );
        }
 
        return $result;
    }
 
    public function getRealName() {
        if ( !$this->isItemLoaded( 'realname' ) ) {
            $this->load();
        }
 
        return $this->mRealName;
    }
 
    public function setRealName( $str ) {
        $this->load();
        $this->mRealName = $str;
    }
 
    public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
        if ( $oname === null ) {
            return null; // b/c
        }
        return MediaWikiServices::getInstance()
            ->getUserOptionsLookup()
            ->getOption( $this, $oname, $defaultOverride, $ignoreHidden );
    }
 
    public function getOptions( $flags = 0 ) {
        return MediaWikiServices::getInstance()
            ->getUserOptionsLookup()
            ->getOptions( $this, $flags );
    }
 
    public function getBoolOption( $oname ) {
        return MediaWikiServices::getInstance()
            ->getUserOptionsLookup()
            ->getBoolOption( $this, $oname );
    }
 
    public function getIntOption( $oname, $defaultOverride = 0 ) {
        if ( $oname === null ) {
            return null; // b/c
        }
        return MediaWikiServices::getInstance()
            ->getUserOptionsLookup()
            ->getIntOption( $this, $oname, $defaultOverride );
    }
 
    public function setOption( $oname, $val ) {
        MediaWikiServices::getInstance()
            ->getUserOptionsManager()
            ->setOption( $this, $oname, $val );
    }
 
    public function getTokenFromOption( $oname ) {
        global $wgHiddenPrefs;
 
        $id = $this->getId();
        if ( !$id || in_array( $oname, $wgHiddenPrefs ) ) {
            return false;
        }
 
        $token = $this->getOption( $oname );
        if ( !$token ) {
            // Default to a value based on the user token to avoid space
            // wasted on storing tokens for all users. When this option
            // is set manually by the user, only then is it stored.
            $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
        }
 
        return $token;
    }
 
    public function resetTokenFromOption( $oname ) {
        global $wgHiddenPrefs;
        if ( in_array( $oname, $wgHiddenPrefs ) ) {
            return false;
        }
 
        $token = MWCryptRand::generateHex( 40 );
        $this->setOption( $oname, $token );
        return $token;
    }
 
    public static function listOptionKinds() {
        return MediaWikiServices::getInstance()
            ->getUserOptionsManager()
            ->listOptionKinds();
    }
 
    public function getOptionKinds( IContextSource $context, $options = null ) {
        return MediaWikiServices::getInstance()
            ->getUserOptionsManager()
            ->getOptionKinds( $this, $context, $options );
    }
 
    public function resetOptions(
        $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
        IContextSource $context = null
    ) {
        MediaWikiServices::getInstance()
            ->getUserOptionsManager()
            ->resetOptions(
                $this,
                $context ?? RequestContext::getMain(),
                $resetKinds
            );
    }
 
    public function getDatePreference() {
        // Important migration for old data rows
        if ( $this->mDatePreference === null ) {
            global $wgLang;
            $value = $this->getOption( 'date' );
            $map = $wgLang->getDatePreferenceMigrationMap();
            if ( isset( $map[$value] ) ) {
                $value = $map[$value];
            }
            $this->mDatePreference = $value;
        }
        return $this->mDatePreference;
    }
 
    public function requiresHTTPS() {
        global $wgForceHTTPS, $wgSecureLogin;
        if ( $wgForceHTTPS ) {
            return true;
        }
        if ( !$wgSecureLogin ) {
            return false;
        }
        $https = $this->getBoolOption( 'prefershttps' );
        $this->getHookRunner()->onUserRequiresHTTPS( $this, $https );
        if ( $https ) {
            $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
        }
 
        return $https;
    }
 
    public function getStubThreshold() {
        global $wgMaxArticleSize; # Maximum article size, in Kb
        $threshold = $this->getIntOption( 'stubthreshold' );
        if ( $threshold > $wgMaxArticleSize * 1024 ) {
            // If they have set an impossible value, disable the preference
            // so we can use the parser cache again.
            $threshold = 0;
        }
        return $threshold;
    }
 
    public function getRights() {
        return MediaWikiServices::getInstance()->getPermissionManager()->getUserPermissions( $this );
    }
 
    public function getGroups() {
        return MediaWikiServices::getInstance()
            ->getUserGroupManager()
            ->getUserGroups( $this, $this->queryFlagsUsed );
    }
 
    public function getGroupMemberships() {
        return MediaWikiServices::getInstance()
            ->getUserGroupManager()
            ->getUserGroupMemberships( $this, $this->queryFlagsUsed );
    }
 
    public function getEffectiveGroups( $recache = false ) {
        return MediaWikiServices::getInstance()
            ->getUserGroupManager()
            ->getUserEffectiveGroups( $this, $this->queryFlagsUsed, $recache );
    }
 
    public function getAutomaticGroups( $recache = false ) {
        return MediaWikiServices::getInstance()
            ->getUserGroupManager()
            ->getUserImplicitGroups( $this, $this->queryFlagsUsed, $recache );
    }
 
    public function getFormerGroups() {
        return MediaWikiServices::getInstance()
            ->getUserGroupManager()
            ->getUserFormerGroups( $this, $this->queryFlagsUsed );
    }
 
    public function getEditCount() {
        if ( !$this->getId() ) {
            return null;
        }
 
        if ( $this->mEditCount === null ) {
            $this->mEditCount = MediaWikiServices::getInstance()
                ->getUserEditTracker()
                ->getUserEditCount( $this );
        }
        return (int)$this->mEditCount;
    }
 
    public function addGroup( $group, $expiry = null ) {
        return MediaWikiServices::getInstance()
            ->getUserGroupManager()
            ->addUserToGroup( $this, $group, $expiry, true );
    }
 
    public function removeGroup( $group ) {
        return MediaWikiServices::getInstance()
            ->getUserGroupManager()
            ->removeUserFromGroup( $this, $group );
    }
 
    public function isRegistered() : bool {
        return $this->getId() != 0;
    }
 
    public function isLoggedIn() {
        return $this->isRegistered();
    }
 
    public function isAnon() {
        return !$this->isRegistered();
    }
 
    public function isBot() {
        if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
            return true;
        }
 
        $isBot = false;
        $this->getHookRunner()->onUserIsBot( $this, $isBot );
 
        return $isBot;
    }
 
    public function isSystemUser() {
        $this->load();
        if ( $this->getEmail() || $this->mToken !== self::INVALID_TOKEN ||
            MediaWikiServices::getInstance()->getAuthManager()->userCanAuthenticate( $this->mName )
        ) {
            return false;
        }
        return true;
    }
 
    public function isAllowedAny( ...$permissions ): bool {
        return $this->getThisAsAuthority()->isAllowedAny( ...$permissions );
    }
 
    public function isAllowedAll( ...$permissions ): bool {
        return $this->getThisAsAuthority()->isAllowedAll( ...$permissions );
    }
 
    public function isAllowed( string $permission ): bool {
        return $this->getThisAsAuthority()->isAllowed( $permission );
    }
 
    public function useRCPatrol() {
        global $wgUseRCPatrol;
        return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
    }
 
    public function useNPPatrol() {
        global $wgUseRCPatrol, $wgUseNPPatrol;
        return (
            ( $wgUseRCPatrol || $wgUseNPPatrol )
                && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
        );
    }
 
    public function useFilePatrol() {
        global $wgUseRCPatrol, $wgUseFilePatrol;
        return (
            ( $wgUseRCPatrol || $wgUseFilePatrol )
                && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
        );
    }
 
    public function getRequest() {
        if ( $this->mRequest ) {
            return $this->mRequest;
        }
        return RequestContext::getMain()->getRequest();
    }
 
    public function isWatched( $title, $checkRights = self::CHECK_USER_RIGHTS ) {
        if ( $title->isWatchable() && ( !$checkRights || $this->isAllowed( 'viewmywatchlist' ) ) ) {
            return MediaWikiServices::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
        }
        return false;
    }
 
    public function isTempWatched( $title, $checkRights = self::CHECK_USER_RIGHTS ): bool {
        if ( $title->isWatchable() && ( !$checkRights || $this->isAllowed( 'viewmywatchlist' ) ) ) {
            return MediaWikiServices::getInstance()->getWatchedItemStore()
                ->isTempWatched( $this, $title );
        }
        return false;
    }
 
    public function addWatch(
        $title,
        $checkRights = self::CHECK_USER_RIGHTS,
        ?string $expiry = null
    ) {
        if ( !$title->isWatchable() ) {
            return;
        }
 
        if ( !$checkRights || $this->isAllowed( 'editmywatchlist' ) ) {
            $store = MediaWikiServices::getInstance()->getWatchedItemStore();
            $store->addWatch( $this, $title->getSubjectPage(), $expiry );
            if ( $title->canHaveTalkPage() ) {
                $store->addWatch( $this, $title->getTalkPage(), $expiry );
            }
        }
        $this->invalidateCache();
    }
 
    public function removeWatch( $title, $checkRights = self::CHECK_USER_RIGHTS ) {
        if ( !$title->isWatchable() ) {
            return;
        }
 
        if ( !$checkRights || $this->isAllowed( 'editmywatchlist' ) ) {
            $store = MediaWikiServices::getInstance()->getWatchedItemStore();
            $store->removeWatch( $this, $title->getSubjectPage() );
            if ( $title->canHaveTalkPage() ) {
                $store->removeWatch( $this, $title->getTalkPage() );
            }
        }
        $this->invalidateCache();
    }
 
    public function clearNotification( &$title, $oldid = 0 ) {
        MediaWikiServices::getInstance()
            ->getWatchlistNotificationManager()
            ->clearTitleUserNotifications( $this, $title, $oldid );
    }
 
    public function clearAllNotifications() {
        wfDeprecated( __METHOD__, '1.35' );
        MediaWikiServices::getInstance()
            ->getWatchlistNotificationManager()
            ->clearAllUserNotifications( $this );
    }
 
    public function getExperienceLevel() {
        global $wgLearnerEdits,
            $wgExperiencedUserEdits,
            $wgLearnerMemberSince,
            $wgExperiencedUserMemberSince;
 
        if ( $this->isAnon() ) {
            return false;
        }
 
        $editCount = $this->getEditCount();
        $registration = $this->getRegistration();
        $now = time();
        $learnerRegistration = wfTimestamp( TS_MW, $now - $wgLearnerMemberSince * 86400 );
        $experiencedRegistration = wfTimestamp( TS_MW, $now - $wgExperiencedUserMemberSince * 86400 );
        if ( $registration === null ) {
            // for some very old accounts, this information is missing in the database
            // treat them as old enough to be 'experienced'
            $registration = $experiencedRegistration;
        }
 
        if ( $editCount < $wgLearnerEdits ||
        $registration > $learnerRegistration ) {
            return 'newcomer';
        }
 
        if ( $editCount > $wgExperiencedUserEdits &&
            $registration <= $experiencedRegistration
        ) {
            return 'experienced';
        }
 
        return 'learner';
    }
 
    public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
        $this->load();
        if ( $this->mId == 0 ) {
            return;
        }
 
        $session = $this->getRequest()->getSession();
        if ( $request && $session->getRequest() !== $request ) {
            $session = $session->sessionWithRequest( $request );
        }
        $delay = $session->delaySave();
 
        if ( !$session->getUser()->equals( $this ) ) {
            if ( !$session->canSetUser() ) {
                \MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
                    ->warning( __METHOD__ .
                        ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
                    );
                return;
            }
            $session->setUser( $this );
        }
 
        $session->setRememberUser( $rememberMe );
        if ( $secure !== null ) {
            $session->setForceHTTPS( $secure );
        }
 
        $session->persist();
 
        ScopedCallback::consume( $delay );
    }
 
    public function logout() {
        // Avoid PHP 7.1 warning of passing $this by reference
        $user = $this;
        if ( $this->getHookRunner()->onUserLogout( $user ) ) {
            $this->doLogout();
        }
    }
 
    public function doLogout() {
        $session = $this->getRequest()->getSession();
        if ( !$session->canSetUser() ) {
            \MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
                ->warning( __METHOD__ . ": Cannot log out of an immutable session" );
            $error = 'immutable';
        } elseif ( !$session->getUser()->equals( $this ) ) {
            \MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
                ->warning( __METHOD__ .
                    ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
                );
            // But we still may as well make this user object anon
            $this->clearInstanceCache( 'defaults' );
            $error = 'wronguser';
        } else {
            $this->clearInstanceCache( 'defaults' );
            $delay = $session->delaySave();
            $session->unpersist(); // Clear cookies (T127436)
            $session->setLoggedOutTimestamp( time() );
            $session->setUser( new User );
            $session->set( 'wsUserID', 0 ); // Other code expects this
            $session->resetAllTokens();
            ScopedCallback::consume( $delay );
            $error = false;
        }
        \MediaWiki\Logger\LoggerFactory::getInstance( 'authevents' )->info( 'Logout', [
            'event' => 'logout',
            'successful' => $error === false,
            'status' => $error ?: 'success',
        ] );
    }
 
    public function saveSettings() {
        if ( wfReadOnly() ) {
            // @TODO: caller should deal with this instead!
            // This should really just be an exception.
            MWExceptionHandler::logException( new DBExpectedError(
                null,
                "Could not update user with ID '{$this->mId}'; DB is read-only."
            ) );
            return;
        }
 
        $this->load();
        if ( $this->mId == 0 ) {
            return; // anon
        }
 
        // Get a new user_touched that is higher than the old one.
        // This will be used for a CAS check as a last-resort safety
        // check against race conditions and replica DB lag.
        $newTouched = $this->newTouchedTimestamp();
 
        $dbw = wfGetDB( DB_MASTER );
        $dbw->doAtomicSection( __METHOD__, function ( IDatabase $dbw, $fname ) use ( $newTouched ) {
            $dbw->update( 'user',
                [ /* SET */
                    'user_name' => $this->mName,
                    'user_real_name' => $this->mRealName,
                    'user_email' => $this->mEmail,
                    'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
                    'user_touched' => $dbw->timestamp( $newTouched ),
                    'user_token' => strval( $this->mToken ),
                    'user_email_token' => $this->mEmailToken,
                    'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires ),
                ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
                    'user_id' => $this->mId,
                ] ), $fname
            );
 
            if ( !$dbw->affectedRows() ) {
                // Maybe the problem was a missed cache update; clear it to be safe
                $this->clearSharedCache( 'refresh' );
                // User was changed in the meantime or loaded with stale data
                $from = ( $this->queryFlagsUsed & self::READ_LATEST ) ? 'master' : 'replica';
                LoggerFactory::getInstance( 'preferences' )->warning(
                    "CAS update failed on user_touched for user ID '{user_id}' ({db_flag} read)",
                    [ 'user_id' => $this->mId, 'db_flag' => $from ]
                );
                throw new MWException( "CAS update failed on user_touched. " .
                    "The version of the user to be saved is older than the current version."
                );
            }
 
            $dbw->update(
                'actor',
                [ 'actor_name' => $this->mName ],
                [ 'actor_user' => $this->mId ],
                $fname
            );
        } );
 
        $this->mTouched = $newTouched;
        MediaWikiServices::getInstance()->getUserOptionsManager()->saveOptions( $this );
 
        $this->getHookRunner()->onUserSaveSettings( $this );
        $this->clearSharedCache( 'changed' );
        $hcu = MediaWikiServices::getInstance()->getHtmlCacheUpdater();
        $hcu->purgeTitleUrls( $this->getUserPage(), $hcu::PURGE_INTENT_TXROUND_REFLECTED );
    }
 
    public function idForName( $flags = self::READ_NORMAL ) {
        $s = trim( $this->getName() );
        if ( $s === '' ) {
            return 0;
        }
 
        list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $flags );
        $db = wfGetDB( $index );
 
        $id = $db->selectField( 'user',
            'user_id', [ 'user_name' => $s ], __METHOD__, $options );
 
        return (int)$id;
    }
 
    public static function createNew( $name, $params = [] ) {
        foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
            if ( isset( $params[$field] ) ) {
                wfDeprecated( __METHOD__ . " with param '$field'", '1.27' );
                unset( $params[$field] );
            }
        }
 
        $user = new User;
        $user->load();
        $user->setToken(); // init token
        if ( isset( $params['options'] ) ) {
            MediaWikiServices::getInstance()
                ->getUserOptionsManager()
                ->loadUserOptions( $user, $user->queryFlagsUsed, $params['options'] );
            unset( $params['options'] );
        }
        $dbw = wfGetDB( DB_MASTER );
 
        $noPass = PasswordFactory::newInvalidPassword()->toString();
 
        $fields = [
            'user_name' => $name,
            'user_password' => $noPass,
            'user_newpassword' => $noPass,
            'user_email' => $user->mEmail,
            'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated ),
            'user_real_name' => $user->mRealName,
            'user_token' => strval( $user->mToken ),
            'user_registration' => $dbw->timestamp( $user->mRegistration ),
            'user_editcount' => 0,
            'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
        ];
        foreach ( $params as $name => $value ) {
            $fields["user_$name"] = $value;
        }
 
        return $dbw->doAtomicSection( __METHOD__, function ( IDatabase $dbw, $fname ) use ( $fields ) {
            $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
            if ( $dbw->affectedRows() ) {
                $newUser = self::newFromId( $dbw->insertId() );
                $newUser->mName = $fields['user_name'];
                $newUser->updateActorId( $dbw );
                // Load the user from master to avoid replica lag
                $newUser->load( self::READ_LATEST );
            } else {
                $newUser = null;
            }
            return $newUser;
        } );
    }
 
    public function addToDatabase() {
        $this->load();
        if ( !$this->mToken ) {
            $this->setToken(); // init token
        }
 
        if ( !is_string( $this->mName ) ) {
            throw new RuntimeException( "User name field is not set." );
        }
 
        $this->mTouched = $this->newTouchedTimestamp();
 
        $dbw = wfGetDB( DB_MASTER );
        $status = $dbw->doAtomicSection( __METHOD__, function ( IDatabase $dbw, $fname ) {
            $noPass = PasswordFactory::newInvalidPassword()->toString();
            $dbw->insert( 'user',
                [
                    'user_name' => $this->mName,
                    'user_password' => $noPass,
                    'user_newpassword' => $noPass,
                    'user_email' => $this->mEmail,
                    'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
                    'user_real_name' => $this->mRealName,
                    'user_token' => strval( $this->mToken ),
                    'user_registration' => $dbw->timestamp( $this->mRegistration ),
                    'user_editcount' => 0,
                    'user_touched' => $dbw->timestamp( $this->mTouched ),
                ], $fname,
                [ 'IGNORE' ]
            );
            if ( !$dbw->affectedRows() ) {
                // Use locking reads to bypass any REPEATABLE-READ snapshot.
                $this->mId = $dbw->selectField(
                    'user',
                    'user_id',
                    [ 'user_name' => $this->mName ],
                    $fname,
                    [ 'LOCK IN SHARE MODE' ]
                );
                $loaded = false;
                if ( $this->mId && $this->loadFromDatabase( self::READ_LOCKING ) ) {
                    $loaded = true;
                }
                if ( !$loaded ) {
                    throw new MWException( $fname . ": hit a key conflict attempting " .
                        "to insert user '{$this->mName}' row, but it was not present in select!" );
                }
                return Status::newFatal( 'userexists' );
            }
            $this->mId = $dbw->insertId();
            self::$idCacheByName[$this->mName] = $this->mId;
            $this->updateActorId( $dbw );
 
            return Status::newGood();
        } );
        if ( !$status->isGood() ) {
            return $status;
        }
 
        // Clear instance cache other than user table data and actor, which is already accurate
        $this->clearInstanceCache();
 
        MediaWikiServices::getInstance()->getUserOptionsManager()->saveOptions( $this );
        return Status::newGood();
    }
 
    private function updateActorId( IDatabase $dbw ) {
        $dbw->insert(
            'actor',
            [ 'actor_user' => $this->mId, 'actor_name' => $this->mName ],
            __METHOD__
        );
        $this->mActorId = (int)$dbw->insertId();
    }
 
    public function spreadAnyEditBlock() {
        if ( $this->isRegistered() && $this->getBlock() ) {
            return $this->spreadBlock();
        }
 
        return false;
    }
 
    protected function spreadBlock() {
        wfDebug( __METHOD__ . "()" );
        $this->load();
        if ( $this->mId == 0 ) {
            return false;
        }
 
        $userblock = DatabaseBlock::newFromTarget( $this->getName() );
        if ( !$userblock ) {
            return false;
        }
 
        return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
    }
 
    public function isBlockedFromCreateAccount() {
        $this->getBlockedStatus();
        if ( $this->mBlock && $this->mBlock->appliesToRight( 'createaccount' ) ) {
            return $this->mBlock;
        }
 
        # T15611: if the IP address the user is trying to create an account from is
        # blocked with createaccount disabled, prevent new account creation there even
        # when the user is logged in
        if ( $this->mBlockedFromCreateAccount === false && !$this->isAllowed( 'ipblock-exempt' ) ) {
            $this->mBlockedFromCreateAccount = DatabaseBlock::newFromTarget(
                null, $this->getRequest()->getIP()
            );
        }
        return $this->mBlockedFromCreateAccount instanceof AbstractBlock
            && $this->mBlockedFromCreateAccount->appliesToRight( 'createaccount' )
            ? $this->mBlockedFromCreateAccount
            : false;
    }
 
    public function isBlockedFromEmailuser() {
        $this->getBlockedStatus();
        return $this->mBlock && $this->mBlock->appliesToRight( 'sendemail' );
    }
 
    public function isBlockedFromUpload() {
        $this->getBlockedStatus();
        return $this->mBlock && $this->mBlock->appliesToRight( 'upload' );
    }
 
    public function isAllowedToCreateAccount() {
        return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
    }
 
    public function getUserPage() {
        return Title::makeTitle( NS_USER, $this->getName() );
    }
 
    public function getTalkPage() {
        $title = $this->getUserPage();
        return $title->getTalkPage();
    }
 
    public function isNewbie() {
        return !$this->isAllowed( 'autoconfirmed' );
    }
 
    public function getEditTokenObject( $salt = '', $request = null ) {
        if ( $this->isAnon() ) {
            return new LoggedOutEditToken();
        }
 
        if ( !$request ) {
            $request = $this->getRequest();
        }
        return $request->getSession()->getToken( $salt );
    }
 
    public function getEditToken( $salt = '', $request = null ) {
        return $this->getEditTokenObject( $salt, $request )->toString();
    }
 
    public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
        return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
    }
 
    public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
        $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token::SUFFIX;
        return $this->matchEditToken( $val, $salt, $request, $maxage );
    }
 
    public function sendConfirmationMail( $type = 'created' ) {
        global $wgLang;
        $expiration = null; // gets passed-by-ref and defined in next line.
        $token = $this->confirmationToken( $expiration );
        $url = $this->confirmationTokenUrl( $token );
        $invalidateURL = $this->invalidationTokenUrl( $token );
        $this->saveSettings();
 
        if ( $type == 'created' || $type === false ) {
            $message = 'confirmemail_body';
            $type = 'created';
        } elseif ( $type === true ) {
            $message = 'confirmemail_body_changed';
            $type = 'changed';
        } else {
            // Messages: confirmemail_body_changed, confirmemail_body_set
            $message = 'confirmemail_body_' . $type;
        }
 
        $mail = [
            'subject' => wfMessage( 'confirmemail_subject' )->text(),
            'body' => wfMessage( $message,
                $this->getRequest()->getIP(),
                $this->getName(),
                $url,
                $wgLang->userTimeAndDate( $expiration, $this ),
                $invalidateURL,
                $wgLang->userDate( $expiration, $this ),
                $wgLang->userTime( $expiration, $this ) )->text(),
            'from' => null,
            'replyTo' => null,
        ];
        $info = [
            'type' => $type,
            'ip' => $this->getRequest()->getIP(),
            'confirmURL' => $url,
            'invalidateURL' => $invalidateURL,
            'expiration' => $expiration
        ];
 
        $this->getHookRunner()->onUserSendConfirmationMail( $this, $mail, $info );
        return $this->sendMail( $mail['subject'], $mail['body'], $mail['from'], $mail['replyTo'] );
    }
 
    public function sendMail( $subject, $body, $from = null, $replyto = null ) {
        global $wgPasswordSender;
 
        if ( $from instanceof User ) {
            $sender = MailAddress::newFromUser( $from );
        } else {
            $sender = new MailAddress( $wgPasswordSender,
                wfMessage( 'emailsender' )->inContentLanguage()->text() );
        }
        $to = MailAddress::newFromUser( $this );
 
        return UserMailer::send( $to, $sender, $subject, $body, [
            'replyTo' => $replyto,
        ] );
    }
 
    protected function confirmationToken( &$expiration ) {
        global $wgUserEmailConfirmationTokenExpiry;
        $now = time();
        $expires = $now + $wgUserEmailConfirmationTokenExpiry;
        $expiration = wfTimestamp( TS_MW, $expires );
        $this->load();
        $token = MWCryptRand::generateHex( 32 );
        $hash = md5( $token );
        $this->mEmailToken = $hash;
        $this->mEmailTokenExpires = $expiration;
        return $token;
    }
 
    protected function confirmationTokenUrl( $token ) {
        return $this->getTokenUrl( 'ConfirmEmail', $token );
    }
 
    protected function invalidationTokenUrl( $token ) {
        return $this->getTokenUrl( 'InvalidateEmail', $token );
    }
 
    protected function getTokenUrl( $page, $token ) {
        // Hack to bypass localization of 'Special:'
        $title = Title::makeTitle( NS_MAIN, "Special:$page/$token" );
        return $title->getCanonicalURL();
    }
 
    public function confirmEmail() {
        // Check if it's already confirmed, so we don't touch the database
        // and fire the ConfirmEmailComplete hook on redundant confirmations.
        if ( !$this->isEmailConfirmed() ) {
            $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
            $this->getHookRunner()->onConfirmEmailComplete( $this );
        }
        return true;
    }
 
    public function invalidateEmail() {
        $this->load();
        $this->mEmailToken = null;
        $this->mEmailTokenExpires = null;
        $this->setEmailAuthenticationTimestamp( null );
        $this->mEmail = '';
        $this->getHookRunner()->onInvalidateEmailComplete( $this );
        return true;
    }
 
    public function setEmailAuthenticationTimestamp( $timestamp ) {
        $this->load();
        $this->mEmailAuthenticated = $timestamp;
        $this->getHookRunner()->onUserSetEmailAuthenticationTimestamp(
            $this, $this->mEmailAuthenticated );
    }
 
    public function canSendEmail() {
        global $wgEnableEmail, $wgEnableUserEmail;
        if ( !$wgEnableEmail || !$wgEnableUserEmail || !$this->isAllowed( 'sendemail' ) ) {
            return false;
        }
        $canSend = $this->isEmailConfirmed();
        $this->getHookRunner()->onUserCanSendEmail( $this, $canSend );
        return $canSend;
    }
 
    public function canReceiveEmail() {
        return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
    }
 
    public function isEmailConfirmed() {
        global $wgEmailAuthentication;
        $this->load();
        // Avoid PHP 7.1 warning of passing $this by reference
        $user = $this;
        $confirmed = true;
        if ( $this->getHookRunner()->onEmailConfirmed( $user, $confirmed ) ) {
            if ( $this->isAnon() ) {
                return false;
            }
            if ( !Sanitizer::validateEmail( $this->getEmail() ) ) {
                return false;
            }
            if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
                return false;
            }
            return true;
        }
 
        return $confirmed;
    }
 
    public function isEmailConfirmationPending() {
        global $wgEmailAuthentication;
        return $wgEmailAuthentication &&
            !$this->isEmailConfirmed() &&
            $this->mEmailToken &&
            $this->mEmailTokenExpires > wfTimestamp();
    }
 
    public function getRegistration() {
        if ( $this->isAnon() ) {
            return false;
        }
        $this->load();
        return $this->mRegistration;
    }
 
    public function getFirstEditTimestamp() {
        return MediaWikiServices::getInstance()
            ->getUserEditTracker()
            ->getFirstEditTimestamp( $this );
    }
 
    public function getLatestEditTimestamp() {
        return MediaWikiServices::getInstance()
            ->getUserEditTracker()
            ->getLatestEditTimestamp( $this );
    }
 
    public static function getGroupPermissions( $groups ) {
        return MediaWikiServices::getInstance()->getPermissionManager()->getGroupPermissions( $groups );
    }
 
    public static function getGroupsWithPermission( $role ) {
        return MediaWikiServices::getInstance()->getPermissionManager()->getGroupsWithPermission( $role );
    }
 
    public static function groupHasPermission( $group, $role ) {
        return MediaWikiServices::getInstance()->getPermissionManager()
            ->groupHasPermission( $group, $role );
    }
 
    public static function getAllGroups() {
        return MediaWikiServices::getInstance()
            ->getUserGroupManager()
            ->listAllGroups();
    }
 
    public static function getImplicitGroups() {
        return MediaWikiServices::getInstance()
            ->getUserGroupManager()
            ->listAllImplicitGroups();
    }
 
    public static function changeableByGroup( $group ) {
        global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
 
        $groups = [
            'add' => [],
            'remove' => [],
            'add-self' => [],
            'remove-self' => []
        ];
 
        if ( empty( $wgAddGroups[$group] ) ) {
            // Don't add anything to $groups
        } elseif ( $wgAddGroups[$group] === true ) {
            // You get everything
            $groups['add'] = self::getAllGroups();
        } elseif ( is_array( $wgAddGroups[$group] ) ) {
            $groups['add'] = $wgAddGroups[$group];
        }
 
        // Same thing for remove
        if ( empty( $wgRemoveGroups[$group] ) ) {
            // Do nothing
        } elseif ( $wgRemoveGroups[$group] === true ) {
            $groups['remove'] = self::getAllGroups();
        } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
            $groups['remove'] = $wgRemoveGroups[$group];
        }
 
        // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
        if ( empty( $wgGroupsAddToSelf['user'] ) || $wgGroupsAddToSelf['user'] !== true ) {
            foreach ( $wgGroupsAddToSelf as $key => $value ) {
                if ( is_int( $key ) ) {
                    $wgGroupsAddToSelf['user'][] = $value;
                }
            }
        }
 
        if ( empty( $wgGroupsRemoveFromSelf['user'] ) || $wgGroupsRemoveFromSelf['user'] !== true ) {
            foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
                if ( is_int( $key ) ) {
                    $wgGroupsRemoveFromSelf['user'][] = $value;
                }
            }
        }
 
        // Now figure out what groups the user can add to him/herself
        if ( empty( $wgGroupsAddToSelf[$group] ) ) {
            // Do nothing
        } elseif ( $wgGroupsAddToSelf[$group] === true ) {
            // No idea WHY this would be used, but it's there
            $groups['add-self'] = self::getAllGroups();
        } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
            $groups['add-self'] = $wgGroupsAddToSelf[$group];
        }
 
        if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
            // Do nothing
        } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
            $groups['remove-self'] = self::getAllGroups();
        } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
            $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
        }
 
        return $groups;
    }
 
    public function changeableGroups() {
        if ( $this->isAllowed( 'userrights' ) ) {
            // This group gives the right to modify everything (reverse-
            // compatibility with old "userrights lets you change
            // everything")
            // Using array_merge to make the groups reindexed
            $all = array_merge( self::getAllGroups() );
            return [
                'add' => $all,
                'remove' => $all,
                'add-self' => [],
                'remove-self' => []
            ];
        }
 
        // Okay, it's not so simple, we will have to go through the arrays
        $groups = [
            'add' => [],
            'remove' => [],
            'add-self' => [],
            'remove-self' => []
        ];
        $addergroups = $this->getEffectiveGroups();
 
        foreach ( $addergroups as $addergroup ) {
            $groups = array_merge_recursive(
                $groups, $this->changeableByGroup( $addergroup )
            );
            $groups['add'] = array_unique( $groups['add'] );
            $groups['remove'] = array_unique( $groups['remove'] );
            $groups['add-self'] = array_unique( $groups['add-self'] );
            $groups['remove-self'] = array_unique( $groups['remove-self'] );
        }
        return $groups;
    }
 
    public function incEditCount() {
        if ( $this->isAnon() ) {
            return; // sanity
        }
 
        DeferredUpdates::addUpdate(
            new UserEditCountUpdate( $this, 1 ),
            DeferredUpdates::POSTSEND
        );
    }
 
    public function setEditCountInternal( $count ) {
        $this->mEditCount = $count;
    }
 
    public function initEditCountInternal( IDatabase $dbr ) {
        return MediaWikiServices::getInstance()
            ->getUserEditTracker()
            ->initializeUserEditCount( $this );
    }
 
    public static function getRightDescription( $right ) {
        $key = "right-$right";
        $msg = wfMessage( $key );
        return $msg->isDisabled() ? $right : $msg->text();
    }
 
    public static function getGrantName( $grant ) {
        wfDeprecated( __METHOD__, '1.36' );
        return MWGrants::grantName( $grant );
    }
 
    public static function getQueryInfo() {
        $ret = [
            'tables' => [ 'user', 'user_actor' => 'actor' ],
            'fields' => [
                'user_id',
                'user_name',
                'user_real_name',
                'user_email',
                'user_touched',
                'user_token',
                'user_email_authenticated',
                'user_email_token',
                'user_email_token_expires',
                'user_registration',
                'user_editcount',
                'user_actor.actor_id',
            ],
            'joins' => [
                'user_actor' => [ 'JOIN', 'user_actor.actor_user = user_id' ],
            ],
        ];
 
        return $ret;
    }
 
    public static function newFatalPermissionDeniedStatus( $permission ) {
        global $wgLang;
 
        $groups = [];
        foreach ( MediaWikiServices::getInstance()
                ->getPermissionManager()
                ->getGroupsWithPermission( $permission ) as $group ) {
            $groups[] = UserGroupMembership::getLink( $group, RequestContext::getMain(), 'wiki' );
        }
 
        if ( $groups ) {
            return Status::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
        }
 
        return Status::newFatal( 'badaccess-group0' );
    }
 
    public function getInstanceForUpdate() {
        if ( !$this->getId() ) {
            return null; // anon
        }
 
        $user = self::newFromId( $this->getId() );
        if ( !$user->loadFromId( self::READ_EXCLUSIVE ) ) {
            return null;
        }
 
        return $user;
    }
 
    public function equals( UserIdentity $user ) : bool {
        // XXX it's not clear whether central ID providers are supposed to obey this
        return $this->getName() === $user->getName();
    }
 
    public function isAllowUsertalk() {
        return $this->mAllowUsertalk;
    }
 
    public function getPerformer(): UserIdentity {
        return $this;
    }
 
    public function probablyCan( string $action, PageIdentity $target, PermissionStatus $status = null ): bool {
        return $this->getThisAsAuthority()->probablyCan( $action, $target, $status );
    }
 
    public function definitelyCan( string $action, PageIdentity $target, PermissionStatus $status = null ): bool {
        return $this->getThisAsAuthority()->definitelyCan( $action, $target, $status );
    }
 
    public function authorizeRead( string $action, PageIdentity $target, PermissionStatus $status = null
    ): bool {
        return $this->getThisAsAuthority()->authorizeRead( $action, $target, $status );
    }
 
    public function authorizeWrite( string $action, PageIdentity $target, PermissionStatus $status = null ): bool {
        return $this->getThisAsAuthority()->authorizeWrite( $action, $target, $status );
    }
 
    private function getThisAsAuthority(): Authority {
        if ( !$this->mThisAsAuthority ) {
            // TODO: For users that are not User::isGlobalSessionUser,
            // creating a UserAuthority here is incorrect, since it depends
            // on global WebRequest, but that is what we've used to do before Authority.
            // When PermissionManager is refactored into Authority, we need
            // to provide base implementation, based on just user groups/rights,
            // and use it here.
            $this->mThisAsAuthority = new UserAuthority(
                $this,
                MediaWikiServices::getInstance()->getPermissionManager()
            );
        }
        return $this->mThisAsAuthority;
    }
 
    private function isGlobalSessionUser(): bool {
        // The session user is set up towards the end of Setup.php. Until then,
        // assume it's a logged-out user.
        $sessionUser = RequestContext::getMain()->getUser();
        $globalUserName = $sessionUser->isSafeToLoad()
            ? $sessionUser->getName()
            : IPUtils::sanitizeIP( $sessionUser->getRequest()->getIP() );
 
        return $this->getName() === $globalUserName;
    }
}