User.php

Go to the documentation of this file.

<?php
namespace MediaWiki\User;
 
use AllowDynamicProperties;
use ArrayIterator;
use DBAccessObjectUtils;
use IDBAccessObject;
use InvalidArgumentException;
use MailAddress;
use MediaWiki\Auth\AuthenticationRequest;
use MediaWiki\Auth\AuthManager;
use MediaWiki\Block\AbstractBlock;
use MediaWiki\Block\Block;
use MediaWiki\Block\SystemBlock;
use MediaWiki\Context\RequestContext;
use MediaWiki\DAO\WikiAwareEntityTrait;
use MediaWiki\HookContainer\ProtectedHookAccessorTrait;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\Mail\UserEmailContact;
use MediaWiki\MainConfigNames;
use MediaWiki\MainConfigSchema;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Parser\Sanitizer;
use MediaWiki\Password\PasswordFactory;
use MediaWiki\Password\UserPasswordPolicy;
use MediaWiki\Permissions\Authority;
use MediaWiki\Permissions\PermissionStatus;
use MediaWiki\Permissions\RateLimitSubject;
use MediaWiki\Permissions\UserAuthority;
use MediaWiki\Request\WebRequest;
use MediaWiki\Session\SessionManager;
use MediaWiki\Session\Token;
use MediaWiki\Status\Status;
use MediaWiki\Title\Title;
use MWCryptHash;
use MWCryptRand;
use MWExceptionHandler;
use RuntimeException;
use stdClass;
use Stringable;
use UnexpectedValueException;
use WANObjectCache;
use Wikimedia\Assert\Assert;
use Wikimedia\Assert\PreconditionException;
use Wikimedia\DebugInfo\DebugInfoTrait;
use Wikimedia\IPUtils;
use Wikimedia\Rdbms\Database;
use Wikimedia\Rdbms\DBExpectedError;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\IReadableDatabase;
use Wikimedia\Rdbms\SelectQueryBuilder;
use Wikimedia\ScopedCallback;
use Wikimedia\Timestamp\ConvertibleTimestamp;
 
#[AllowDynamicProperties]
class User implements Stringable, Authority, UserIdentity, UserEmailContact {
    use DebugInfoTrait;
    use ProtectedHookAccessorTrait;
    use WikiAwareEntityTrait;
 
    public const READ_EXCLUSIVE = IDBAccessObject::READ_EXCLUSIVE;
 
    public const READ_LOCKING = IDBAccessObject::READ_LOCKING;
 
    public const TOKEN_LENGTH = 32;
 
    public const INVALID_TOKEN = '*** INVALID ***';
 
    private const VERSION = 17;
 
    public const MAINTENANCE_SCRIPT_USER = 'Maintenance script';
 
    protected static $mCacheVars = [
        // user table
        'mId',
        'mName',
        'mRealName',
        'mEmail',
        'mTouched',
        'mToken',
        'mEmailAuthenticated',
        'mEmailToken',
        'mEmailTokenExpires',
        'mRegistration',
        // 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 $mLoadedItems = [];
    // @}
 
    public $mFrom;
 
    protected $mDatePreference;
    protected $mHash;
    protected $mGlobalBlock;
    protected $mLocked;
 
    private $mRequest;
 
    protected $queryFlagsUsed = IDBAccessObject::READ_NORMAL;
 
    private $mThisAsAuthority;
 
    private $isTemp;
 
    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' ) {
            // hard deprecated since 1.40
            wfDeprecated( 'User::$mRights', '1.34' );
            $copy = MediaWikiServices::getInstance()
                ->getPermissionManager()
                ->getUserPermissions( $this );
            return $copy;
        } 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' ) {
            // hard deprecated since 1.40
            wfDeprecated( 'User::$mRights', '1.34' );
            MediaWikiServices::getInstance()->getPermissionManager()->overrideUserRightsForTesting(
                $this,
                $value ?? []
            );
        } 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 = IDBAccessObject::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' ) {
            LoggerFactory::getInstance( 'session' )
                ->warning( 'User::loadFromSession called before the end of Setup.php', [
                    'exception' => new RuntimeException(
                        '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->hasOrMadeRecentPrimaryChanges() ) {
                        $flags |= IDBAccessObject::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->hasOrMadeRecentPrimaryChanges() ) {
                    $flags |= IDBAccessObject::READ_LATEST;
                    $this->queryFlagsUsed = $flags;
                }
 
                $dbr = DBAccessObjectUtils::getDBFromRecency(
                    MediaWikiServices::getInstance()->getDBLoadBalancerFactory(),
                    $flags
                );
                $queryBuilder = $dbr->newSelectQueryBuilder()
                    ->select( [ 'actor_id', 'actor_user', 'actor_name' ] )
                    ->from( 'actor' )
                    ->recency( $flags );
                if ( $this->mFrom === 'name' ) {
                    // make sure to use normalized form of IP for anonymous users
                    $queryBuilder->where( [ 'actor_name' => IPUtils::sanitizeIP( $this->mName ) ] );
                } else {
                    $queryBuilder->where( [ 'actor_id' => $this->mActorId ] );
                }
                $row = $queryBuilder->caller( __METHOD__ )->fetchRow();
 
                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 = IDBAccessObject::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 primary DB).
        // NOTE: if this thread called saveSettings(), the cache was cleared.
        $latest = DBAccessObjectUtils::hasFlags( $flags, IDBAccessObject::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 );
    }
 
    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(
                    MediaWikiServices::getInstance()->getConnectionProvider()->getReplicaDatabase()
                );
                wfDebug( "User: cache miss for user {$this->mId}" );
 
                $this->loadFromDatabase( IDBAccessObject::READ_NORMAL );
 
                $data = [];
                foreach ( self::$mCacheVars as $name ) {
                    $data[$name] = $this->$name;
                }
 
                $ttl = $cache->adaptiveTTL(
                    (int)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 =
                                (int)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' => UserRigorOptions::RIGOR_VALID,
            'usable' => UserRigorOptions::RIGOR_USABLE,
            'creatable' => UserRigorOptions::RIGOR_CREATABLE
        ];
        if ( $validate === true ) {
            $validate = 'valid';
        }
        if ( $validate === false ) {
            $validation = UserRigorOptions::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()->getUserFactory()
            ->newFromName( (string)$name, $validation ) ?? false;
    }
 
    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 = IDBAccessObject::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' => UserRigorOptions::RIGOR_VALID,
            'create' => true,
            'steal' => false,
        ];
 
        // Username validation
        // Backwards compatibility with strings / false
        $validationLevels = [
            'valid' => UserRigorOptions::RIGOR_VALID,
            'usable' => UserRigorOptions::RIGOR_USABLE,
            'creatable' => UserRigorOptions::RIGOR_CREATABLE
        ];
        $validate = $options['validate'];
 
        // @phan-suppress-next-line PhanSuspiciousValueComparison
        if ( $validate === false ) {
            $validation = UserRigorOptions::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 !== UserRigorOptions::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;
        }
 
        $dbProvider = $services->getDBLoadBalancerFactory();
        $dbr = $dbProvider->getReplicaDatabase();
 
        $userQuery = self::newQueryBuilder( $dbr )
            ->where( [ 'user_name' => $name ] )
            ->caller( __METHOD__ );
        $row = $userQuery->fetchRow();
        if ( !$row ) {
            // Try the primary database
            $userQuery->connection( $dbProvider->getPrimaryDatabase() );
            // Lock the row to prevent insertNewUser() returning null due to race conditions
            $userQuery->forUpdate();
            $row = $userQuery->fetchRow();
        }
 
        if ( !$row ) {
            // No user. Create it?
            // @phan-suppress-next-line PhanImpossibleCondition
            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.
            return self::insertNewUser( static function ( UserIdentity $actor, IDatabase $dbw ) {
                return MediaWikiServices::getInstance()->getActorStore()
                    ->acquireSystemActorId( $actor, $dbw );
            }, $name, [ 'token' => self::INVALID_TOKEN ] );
        }
 
        $user = self::newFromRow( $row );
 
        if ( !$user->isSystemUser() ) {
            // User exists. Steal it?
            // @phan-suppress-next-line PhanRedundantCondition
            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 MediaWikiServices::getInstance()->getUserCache()
            ->getProp( $id, 'name' );
    }
 
    public static function whoIsReal( $id ) {
        return MediaWikiServices::getInstance()->getUserCache()
            ->getProp( $id, 'real_name' );
    }
 
    public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
        if ( $groups === [] ) {
            return UserArrayFromResult::newFromIDs( [] );
        }
        $dbr = MediaWikiServices::getInstance()->getConnectionProvider()->getReplicaDatabase();
        $queryBuilder = $dbr->newSelectQueryBuilder()
            ->select( 'ug_user' )
            ->distinct()
            ->from( 'user_groups' )
            ->where( [ 'ug_group' => array_unique( (array)$groups ) ] )
            ->orderBy( 'ug_user' )
            ->limit( min( 5000, $limit ) );
 
        if ( $after !== null ) {
            $queryBuilder->andWhere( $dbr->expr( 'ug_user', '>', (int)$after ) );
        }
 
        $ids = $queryBuilder->caller( __METHOD__ )->fetchFieldValues() ?: [];
        return UserArray::newFromIDs( $ids );
    }
 
    public function isValidPassword( $password ) {
        // simple boolean wrapper for checkPasswordValidity
        return $this->checkPasswordValidity( $password )->isGood();
    }
 
    public function checkPasswordValidity( $password ) {
        $passwordPolicy = MediaWikiServices::getInstance()->getMainConfig()
            ->get( MainConfigNames::PasswordPolicy );
 
        $upp = new UserPasswordPolicy(
            $passwordPolicy['policies'],
            $passwordPolicy['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 function loadDefaults( $name = false, $actorId = null ) {
        $this->mId = 0;
        $this->mName = $name;
        $this->mActorId = $actorId;
        $this->mRealName = '';
        $this->mEmail = '';
        $this->isTemp = null;
 
        $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 = IDBAccessObject::READ_LATEST ) {
        // Paranoia
        $this->mId = intval( $this->mId );
 
        if ( !$this->mId ) {
            // Anonymous users are not in the database
            $this->loadDefaults();
            return false;
        }
 
        $db = DBAccessObjectUtils::getDBFromRecency(
            MediaWikiServices::getInstance()->getDBLoadBalancerFactory(),
            $flags
        );
        $row = self::newQueryBuilder( $db )
            ->where( [ 'user_id' => $this->mId ] )
            ->recency( $flags )
            ->caller( __METHOD__ )
            ->fetchRow();
 
        $this->queryFlagsUsed = $flags;
 
        if ( $row !== false ) {
            // Initialise user table data
            $this->loadFromRow( $row );
            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_editcount ) ) {
            // Don't try to set edit count for anonymous users
            // We check the id here and not in UserEditTracker because calling
            // User::getId() can trigger some other loading. This will result in
            // discarding the user_editcount field for rows if the id wasn't set.
            if ( $this->mId !== null && $this->mId !== 0 ) {
                MediaWikiServices::getInstance()
                    ->getUserEditTracker()
                    ->setCachedUserEditCount( $this, (int)$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
                    );
            }
        }
    }
 
    protected function loadFromUserObject( $user ) {
        $user->load();
        foreach ( self::$mCacheVars as $var ) {
            $this->$var = $user->$var;
        }
    }
 
    protected function makeUpdateConditions( IReadableDatabase $db, array $conditions ) {
        if ( $this->mTouched ) {
            // CAS check: only update if the row wasn't changed since 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 = MediaWikiServices::getInstance()->getConnectionProvider()->getPrimaryDatabase();
        $dbw->newUpdateQueryBuilder()
            ->update( 'user' )
            ->set( [ 'user_touched' => $dbw->timestamp( $newTouched ) ] )
            ->where( $this->makeUpdateConditions( $dbw, [
                'user_id' => $this->mId,
            ] ) )
            ->caller( __METHOD__ )->execute();
        $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->mHash = false;
        $this->mThisAsAuthority = null;
 
        if ( $wgFullyInitialised && $this->mFrom ) {
            $services = MediaWikiServices::getInstance();
 
            if ( $services->peekService( 'PermissionManager' ) ) {
                $services->getPermissionManager()->invalidateUsersRightsCache( $this );
            }
 
            if ( $services->peekService( 'UserOptionsManager' ) ) {
                $services->getUserOptionsManager()->clearUserOptionsCache( $this );
            }
 
            if ( $services->peekService( 'TalkPageNotificationManager' ) ) {
                $services->getTalkPageNotificationManager()->clearInstanceCache( $this );
            }
 
            if ( $services->peekService( 'UserGroupManager' ) ) {
                $services->getUserGroupManager()->clearCache( $this );
            }
 
            if ( $services->peekService( 'UserEditTracker' ) ) {
                $services->getUserEditTracker()->clearUserEditCache( $this );
            }
 
            if ( $services->peekService( 'BlockManager' ) ) {
                $services->getBlockManager()->clearUserCache( $this );
            }
        }
 
        if ( $reloadFrom ) {
            if ( in_array( $reloadFrom, [ 'name', 'id', 'actor' ] ) ) {
                $this->mLoadedItems = [ $reloadFrom => true ];
            } else {
                $this->mLoadedItems = [];
            }
            $this->mFrom = $reloadFrom;
        }
    }
 
    public function isPingLimitable() {
        $limiter = MediaWikiServices::getInstance()->getRateLimiter();
        $subject = $this->toRateLimitSubject();
        return !$limiter->isExempt( $subject );
    }
 
    public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
        return $this->getThisAsAuthority()->limit( $action, $incrBy, null );
    }
 
    public function toRateLimitSubject(): RateLimitSubject {
        $flags = [
            'exempt' => $this->isAllowed( 'noratelimit' ),
            'newbie' => $this->isNewbie(),
        ];
 
        return new RateLimitSubject( $this, $this->getRequest()->getIP(), $flags );
    }
 
    public function getBlock(
        $freshness = IDBAccessObject::READ_NORMAL,
        $disableIpBlockExemptChecking = false
    ): ?Block {
        if ( is_bool( $freshness ) ) {
            $fromReplica = $freshness;
        } else {
            $fromReplica = ( $freshness !== IDBAccessObject::READ_LATEST );
        }
 
        if ( $disableIpBlockExemptChecking ) {
            $isExempt = false;
        } else {
            $isExempt = $this->isAllowed( 'ipblock-exempt' );
        }
 
        // 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 ( !$isExempt && $this->isGlobalSessionUser() ) {
            // This is the global user, so we need to pass the request
            $request = $this->getRequest();
        }
 
        return MediaWikiServices::getInstance()->getBlockManager()->getBlock(
            $this,
            $request,
            $fromReplica,
        );
    }
 
    public function isBlockedGlobally( $ip = '' ) {
        wfDeprecated( __METHOD__, '1.40' );
        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() {
        $block = $this->getBlock();
        return $block ? $block->getHideName() : false;
    }
 
    public function getId( $wikiId = self::LOCAL ): int {
        $this->assertWiki( $wikiId );
        if ( $this->mId === null && $this->mName !== null ) {
            $userNameUtils = MediaWikiServices::getInstance()->getUserNameUtils();
            if ( $userNameUtils->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 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 canExist() {
        $userNameUtils = MediaWikiServices::getInstance()->getUserNameUtils();
        return ( ( $this->mFrom === 'name' && $userNameUtils->isUsable( $this->mName ) ) || $this->isRegistered() );
    }
 
    public function getActorId( $dbwOrWikiId = self::LOCAL ): int {
        if ( $dbwOrWikiId ) {
            wfDeprecatedMsg( 'Passing a parameter to getActorId() is deprecated', '1.36' );
        }
 
        if ( is_string( $dbwOrWikiId ) ) {
            $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->setItemLoaded( 'actor' );
    }
 
    public function getTitleKey(): string {
        return str_replace( ' ', '_', $this->getName() );
    }
 
    private function newTouchedTimestamp() {
        $time = (int)ConvertibleTimestamp::now( TS_UNIX );
        if ( $this->mTouched ) {
            $time = max( $time, (int)ConvertibleTimestamp::convert( TS_UNIX, $this->mTouched ) + 1 );
        }
 
        return ConvertibleTimestamp::convert( TS_MW, $time );
    }
 
    public function clearSharedCache( $mode = 'refresh' ) {
        if ( !$this->getId() ) {
            return;
        }
 
        $dbProvider = MediaWikiServices::getInstance()->getConnectionProvider();
        $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
        $key = $this->getCacheKey( $cache );
 
        if ( $mode === 'refresh' ) {
            $cache->delete( $key, 1 ); // low tombstone/"hold-off" TTL
        } else {
            $dbProvider->getPrimaryDatabase()->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 ) {
        $authenticationTokenVersion = MediaWikiServices::getInstance()
            ->getMainConfig()->get( MainConfigNames::AuthenticationTokenVersion );
 
        $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 ( $authenticationTokenVersion === null ) {
            // $wgAuthenticationTokenVersion not in use, so return the raw secret
            return $this->mToken;
        }
 
        // $wgAuthenticationTokenVersion in use, so hmac it.
        $ret = MWCryptHash::hmac( $authenticationTokenVersion, $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 ) {
            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(): string {
        $this->load();
        $email = $this->mEmail;
        $this->getHookRunner()->onUserGetEmail( $this, $email );
        // In case a hook handler returns e.g. null
        $this->mEmail = is_string( $email ) ? $email : '';
        return $this->mEmail;
    }
 
    public function getEmailAuthenticationTimestamp() {
        $this->load();
        $this->getHookRunner()->onUserGetEmailAuthenticationTimestamp(
            $this, $this->mEmailAuthenticated );
        return $this->mEmailAuthenticated;
    }
 
    public function setEmail( string $str ) {
        $this->load();
        if ( $str == $this->getEmail() ) {
            return;
        }
        $this->invalidateEmail();
        $this->mEmail = $str;
        $this->getHookRunner()->onUserSetEmail( $this, $this->mEmail );
    }
 
    public function setEmailWithConfirmation( string $str ) {
        $config = MediaWikiServices::getInstance()->getMainConfig();
        $enableEmail = $config->get( MainConfigNames::EnableEmail );
 
        if ( !$enableEmail ) {
            return Status::newFatal( 'emaildisabled' );
        }
 
        $oldaddr = $this->getEmail();
        if ( $str === $oldaddr ) {
            return Status::newGood( true );
        }
 
        $type = $oldaddr != '' ? 'changed' : 'set';
        $notificationResult = null;
 
        $emailAuthentication = $config->get( MainConfigNames::EmailAuthentication );
 
        if ( $emailAuthentication && $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 !== '' && $emailAuthentication ) {
            // 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(): string {
        if ( !$this->isItemLoaded( 'realname' ) ) {
            $this->load();
        }
 
        return $this->mRealName;
    }
 
    public function setRealName( string $str ) {
        $this->load();
        $this->mRealName = $str;
    }
 
    public function getTokenFromOption( $oname ) {
        $hiddenPrefs =
            MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::HiddenPrefs );
 
        $id = $this->getId();
        if ( !$id || in_array( $oname, $hiddenPrefs ) ) {
            return false;
        }
 
        $userOptionsLookup = MediaWikiServices::getInstance()
            ->getUserOptionsLookup();
        $token = $userOptionsLookup->getOption( $this, (string)$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 ) {
        $hiddenPrefs =
            MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::HiddenPrefs );
        if ( in_array( $oname, $hiddenPrefs ) ) {
            return false;
        }
 
        $token = MWCryptRand::generateHex( 40 );
        MediaWikiServices::getInstance()
            ->getUserOptionsManager()
            ->setOption( $this, $oname, $token );
        return $token;
    }
 
    public function getDatePreference() {
        // Important migration for old data rows
        if ( $this->mDatePreference === null ) {
            global $wgLang;
            $userOptionsLookup = MediaWikiServices::getInstance()
                ->getUserOptionsLookup();
            $value = $userOptionsLookup->getOption( $this, 'date' );
            $map = $wgLang->getDatePreferenceMigrationMap();
            if ( isset( $map[$value] ) ) {
                $value = $map[$value];
            }
            $this->mDatePreference = $value;
        }
        return $this->mDatePreference;
    }
 
    public function requiresHTTPS() {
        if ( !$this->isRegistered() ) {
            return false;
        }
 
        $services = MediaWikiServices::getInstance();
        $config = $services->getMainConfig();
        if ( $config->get( MainConfigNames::ForceHTTPS ) ) {
            return true;
        }
        if ( !$config->get( MainConfigNames::SecureLogin ) ) {
            return false;
        }
        return $services->getUserOptionsLookup()
            ->getBoolOption( $this, 'prefershttps' );
    }
 
    public function getEditCount() {
        return MediaWikiServices::getInstance()
            ->getUserEditTracker()
            ->getUserEditCount( $this );
    }
 
    public function isRegistered(): bool {
        return $this->getId() != 0;
    }
 
    public function isAnon() {
        return !$this->isRegistered();
    }
 
    public function isBot() {
        $userGroupManager = MediaWikiServices::getInstance()->getUserGroupManager();
        if ( in_array( 'bot', $userGroupManager->getUserGroups( $this ) )
            && $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, PermissionStatus $status = null ): bool {
        return $this->getThisAsAuthority()->isAllowed( $permission, $status );
    }
 
    public function useRCPatrol() {
        $useRCPatrol =
            MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::UseRCPatrol );
        return $useRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
    }
 
    public function useNPPatrol() {
        $useRCPatrol =
            MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::UseRCPatrol );
        $useNPPatrol =
            MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::UseNPPatrol );
        return (
            ( $useRCPatrol || $useNPPatrol )
                && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
        );
    }
 
    public function useFilePatrol() {
        $useRCPatrol =
            MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::UseRCPatrol );
        $useFilePatrol = MediaWikiServices::getInstance()->getMainConfig()
            ->get( MainConfigNames::UseFilePatrol );
        return (
            ( $useRCPatrol || $useFilePatrol )
                && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
        );
    }
 
    public function getRequest(): WebRequest {
        return $this->mRequest ?? RequestContext::getMain()->getRequest();
    }
 
    public function getExperienceLevel() {
        $mainConfig = MediaWikiServices::getInstance()->getMainConfig();
        $learnerEdits = $mainConfig->get( MainConfigNames::LearnerEdits );
        $experiencedUserEdits = $mainConfig->get( MainConfigNames::ExperiencedUserEdits );
        $learnerMemberSince = $mainConfig->get( MainConfigNames::LearnerMemberSince );
        $experiencedUserMemberSince =
            $mainConfig->get( MainConfigNames::ExperiencedUserMemberSince );
        if ( $this->isAnon() ) {
            return false;
        }
 
        $editCount = $this->getEditCount();
        $registration = $this->getRegistration();
        $now = time();
        $learnerRegistration = wfTimestamp( TS_MW, $now - $learnerMemberSince * 86400 );
        $experiencedRegistration = wfTimestamp( TS_MW, $now - $experiencedUserMemberSince * 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 < $learnerEdits ||
        $registration > $learnerRegistration ) {
            return 'newcomer';
        }
 
        if ( $editCount > $experiencedUserEdits &&
            $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() ) {
                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() {
        if ( $this->getHookRunner()->onUserLogout( $this ) ) {
            $this->doLogout();
        }
    }
 
    public function doLogout() {
        $session = $this->getRequest()->getSession();
        if ( !$session->canSetUser() ) {
            LoggerFactory::getInstance( 'session' )
                ->warning( __METHOD__ . ": Cannot log out of an immutable session" );
            $error = 'immutable';
        } elseif ( !$session->getUser()->equals( $this ) ) {
            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;
        }
        LoggerFactory::getInstance( 'authevents' )->info( 'Logout', [
            'event' => 'logout',
            'successful' => $error === false,
            'status' => $error ?: 'success',
        ] );
    }
 
    public function saveSettings() {
        if ( MediaWikiServices::getInstance()->getReadOnlyMode()->isReadOnly() ) {
            // @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 = MediaWikiServices::getInstance()->getConnectionProvider()->getPrimaryDatabase();
        $dbw->doAtomicSection( __METHOD__, function ( IDatabase $dbw, $fname ) use ( $newTouched ) {
            $dbw->newUpdateQueryBuilder()
                ->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 ),
                ] )
                ->where( $this->makeUpdateConditions( $dbw, [ /* WHERE */
                    'user_id' => $this->mId,
                ] ) )
                ->caller( $fname )->execute();
 
            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 & IDBAccessObject::READ_LATEST ) ? 'primary' : '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 RuntimeException( "CAS update failed on user_touched. " .
                    "The version of the user to be saved is older than the current version."
                );
            }
 
            $dbw->newUpdateQueryBuilder()
                ->update( 'actor' )
                ->set( [ 'actor_name' => $this->mName ] )
                ->where( [ 'actor_user' => $this->mId ] )
                ->caller( $fname )->execute();
            MediaWikiServices::getInstance()->getActorStore()->deleteUserIdentityFromCache( $this );
        } );
 
        $this->mTouched = $newTouched;
        if ( $this->isNamed() ) {
            MediaWikiServices::getInstance()->getUserOptionsManager()->saveOptionsInternal( $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 = IDBAccessObject::READ_NORMAL ) {
        $s = trim( $this->getName() );
        if ( $s === '' ) {
            return 0;
        }
 
        $db = DBAccessObjectUtils::getDBFromRecency(
            MediaWikiServices::getInstance()->getDBLoadBalancerFactory(),
            $flags
        );
        $id = $db->newSelectQueryBuilder()
            ->select( 'user_id' )
            ->from( 'user' )
            ->where( [ 'user_name' => $s ] )
            ->recency( $flags )
            ->caller( __METHOD__ )->fetchField();
 
        return (int)$id;
    }
 
    public static function createNew( $name, $params = [] ) {
        return self::insertNewUser( static function ( UserIdentity $actor, IDatabase $dbw ) {
            return MediaWikiServices::getInstance()->getActorStore()->createNewActor( $actor, $dbw );
        }, $name, $params );
    }
 
    private static function insertNewUser( callable $insertActor, $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
        $dbw = MediaWikiServices::getInstance()->getConnectionProvider()->getPrimaryDatabase();
 
        $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__, static function ( IDatabase $dbw, $fname )
            use ( $fields, $insertActor )
        {
            $dbw->newInsertQueryBuilder()
                ->insertInto( 'user' )
                ->ignore()
                ->row( $fields )
                ->caller( $fname )->execute();
            if ( $dbw->affectedRows() ) {
                $newUser = self::newFromId( $dbw->insertId() );
                $newUser->mName = $fields['user_name'];
                // Don't pass $this, since calling ::getId, ::getName might force ::load
                // and this user might not be ready for the yet.
                $newUser->mActorId = $insertActor(
                    new UserIdentityValue( $newUser->mId, $newUser->mName ),
                    $dbw
                );
                // Load the user from primary DB to avoid replica lag
                $newUser->load( IDBAccessObject::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 = MediaWikiServices::getInstance()->getConnectionProvider()->getPrimaryDatabase();
        $status = $dbw->doAtomicSection( __METHOD__, function ( IDatabase $dbw, $fname ) {
            $noPass = PasswordFactory::newInvalidPassword()->toString();
            $dbw->newInsertQueryBuilder()
                ->insertInto( 'user' )
                ->ignore()
                ->row( [
                    '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 ),
                    'user_is_temp' => $this->isTemp(),
                ] )
                ->caller( $fname )->execute();
            if ( !$dbw->affectedRows() ) {
                // Use locking reads to bypass any REPEATABLE-READ snapshot.
                $this->mId = $dbw->newSelectQueryBuilder()
                    ->select( 'user_id' )
                    ->lockInShareMode()
                    ->from( 'user' )
                    ->where( [ 'user_name' => $this->mName ] )
                    ->caller( $fname )->fetchField();
                $loaded = false;
                if ( $this->mId && $this->loadFromDatabase( IDBAccessObject::READ_LOCKING ) ) {
                    $loaded = true;
                }
                if ( !$loaded ) {
                    throw new RuntimeException( $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();
 
            // Don't pass $this, since calling ::getId, ::getName might force ::load
            // and this user might not be ready for the yet.
            $this->mActorId = MediaWikiServices::getInstance()
                ->getActorNormalization()
                ->acquireActorId( new UserIdentityValue( $this->mId, $this->mName ), $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();
 
        if ( $this->isNamed() ) {
            MediaWikiServices::getInstance()->getUserOptionsManager()->saveOptions( $this );
        }
        return Status::newGood();
    }
 
    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;
        }
 
        $blockStore = MediaWikiServices::getInstance()->getDatabaseBlockStore();
 
        $userblock = $blockStore->newFromTarget( $this->getName() );
        if ( !$userblock ) {
            return false;
        }
 
        return (bool)$blockStore->doAutoblock( $userblock, $this->getRequest()->getIP() );
    }
 
    public function isBlockedFromEmailuser() {
        wfDeprecated( __METHOD__, '1.41' );
        $block = $this->getBlock();
        return $block && $block->appliesToRight( 'sendemail' );
    }
 
    public function isBlockedFromUpload() {
        $block = $this->getBlock();
        return $block && $block->appliesToRight( 'upload' );
    }
 
    public function isAllowedToCreateAccount() {
        return $this->getThisAsAuthority()->isDefinitelyAllowed( 'createaccount' );
    }
 
    public function getUserPage() {
        return Title::makeTitle( NS_USER, $this->getName() );
    }
 
    public function getTalkPage() {
        $title = $this->getUserPage();
        return $title->getTalkPage();
    }
 
    public function isNewbie() {
        // IP users and temp account users are excluded from the autoconfirmed group.
        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 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 ) {
        $passwordSender = MediaWikiServices::getInstance()->getMainConfig()
            ->get( MainConfigNames::PasswordSender );
 
        if ( $from instanceof User ) {
            $sender = MailAddress::newFromUser( $from );
        } else {
            $sender = new MailAddress( $passwordSender,
                wfMessage( 'emailsender' )->inContentLanguage()->text() );
        }
        $to = MailAddress::newFromUser( $this );
 
        if ( is_array( $body ) ) {
            $bodyText = $body['text'] ?? '';
            $bodyHtml = $body['html'] ?? null;
        } else {
            $bodyText = $body;
            $bodyHtml = null;
        }
 
        return Status::wrap( MediaWikiServices::getInstance()->getEmailer()
            ->send(
                [ $to ],
                $sender,
                $subject,
                $bodyText,
                $bodyHtml,
                [ 'replyTo' => $replyto ]
            ) );
    }
 
    protected function confirmationToken( &$expiration ) {
        $userEmailConfirmationTokenExpiry = MediaWikiServices::getInstance()
            ->getMainConfig()->get( MainConfigNames::UserEmailConfirmationTokenExpiry );
        $now = time();
        $expires = $now + $userEmailConfirmationTokenExpiry;
        $expiration = wfTimestamp( TS_MW, $expires );
        $this->load();
        $token = MWCryptRand::generateHex( 32 );
        $hash = md5( $token );
        $this->mEmailToken = $hash;
        $this->mEmailTokenExpires = $expiration;
        return $token;
    }
 
    public static function isWellFormedConfirmationToken( string $token ): bool {
        return preg_match( '/^[a-f0-9]{32}$/', $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() {
        wfDeprecated( __METHOD__, '1.41' );
        $permError = MediaWikiServices::getInstance()->getEmailUserFactory()
            ->newEmailUser( $this->getThisAsAuthority() )
            ->canSend();
        return $permError->isGood();
    }
 
    public function canReceiveEmail() {
        $userOptionsLookup = MediaWikiServices::getInstance()
            ->getUserOptionsLookup();
        return $this->isEmailConfirmed() && !$userOptionsLookup->getOption( $this, 'disablemail' );
    }
 
    public function isEmailConfirmed(): bool {
        $emailAuthentication = MediaWikiServices::getInstance()->getMainConfig()
            ->get( MainConfigNames::EmailAuthentication );
        $this->load();
        $confirmed = true;
        if ( $this->getHookRunner()->onEmailConfirmed( $this, $confirmed ) ) {
            return !$this->isAnon() &&
                Sanitizer::validateEmail( $this->getEmail() ) &&
                ( !$emailAuthentication || $this->getEmailAuthenticationTimestamp() );
        }
 
        return $confirmed;
    }
 
    public function isEmailConfirmationPending() {
        $emailAuthentication = MediaWikiServices::getInstance()->getMainConfig()
            ->get( MainConfigNames::EmailAuthentication );
        return $emailAuthentication &&
            !$this->isEmailConfirmed() &&
            $this->mEmailToken &&
            $this->mEmailTokenExpires > wfTimestamp();
    }
 
    public function getRegistration() {
        if ( $this->isAnon() ) {
            return false;
        }
        $this->load();
        return $this->mRegistration;
    }
 
    public static function getRightDescription( $right ) {
        $key = "right-$right";
        $msg = wfMessage( $key );
        return $msg->isDisabled() ? $right : $msg->text();
    }
 
    public static function getRightDescriptionHtml( $right ) {
        return wfMessage( "right-$right" )->parse();
    }
 
    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 newQueryBuilder( IReadableDatabase $db ) {
        return $db->newSelectQueryBuilder()
            ->select( [
                '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',
            ] )
            ->from( 'user' )
            ->join( 'actor', 'user_actor', 'user_actor.actor_user = user_id' );
    }
 
    public static function newFatalPermissionDeniedStatus( $permission ) {
        return Status::wrap( MediaWikiServices::getInstance()->getPermissionManager()
            ->newFatalPermissionDeniedStatus(
                $permission,
                RequestContext::getMain()
            ) );
    }
 
    public function getInstanceForUpdate() {
        if ( !$this->getId() ) {
            return null; // anon
        }
 
        $user = self::newFromId( $this->getId() );
        if ( !$user->loadFromId( IDBAccessObject::READ_EXCLUSIVE ) ) {
            return null;
        }
 
        return $user;
    }
 
    public function equals( ?UserIdentity $user ): bool {
        if ( !$user ) {
            return false;
        }
        // XXX it's not clear whether central ID providers are supposed to obey this
        return $this->getName() === $user->getName();
    }
 
    public function getUser(): 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 isDefinitelyAllowed( string $action, PermissionStatus $status = null ): bool {
        return $this->getThisAsAuthority()->isDefinitelyAllowed( $action, $status );
    }
 
    public function authorizeAction( string $action, PermissionStatus $status = null ): bool {
        return $this->getThisAsAuthority()->authorizeAction( $action, $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(): UserAuthority {
        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.
            $request = $this->getRequest();
            $uiContext = RequestContext::getMain();
 
            $services = MediaWikiServices::getInstance();
            $this->mThisAsAuthority = new UserAuthority(
                $this,
                $request,
                $uiContext,
                $services->getPermissionManager(),
                $services->getRateLimiter(),
                $services->getFormatterFactory()->getBlockErrorFormatter( $uiContext )
            );
        }
 
        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;
    }
 
    public function isTemp(): bool {
        if ( $this->isTemp === null ) {
            $this->isTemp = MediaWikiServices::getInstance()->getUserIdentityUtils()
                ->isTemp( $this );
        }
        return $this->isTemp;
    }
 
    public function isNamed(): bool {
        return $this->isRegistered() && !$this->isTemp();
    }
}
 
class_alias( User::class, 'User' );