User.php

Go to the documentation of this file.

<?php
use MediaWiki\Block\AbstractBlock;
use MediaWiki\Block\DatabaseBlock;
use MediaWiki\Block\SystemBlock;
use MediaWiki\MediaWikiServices;
use MediaWiki\Session\SessionManager;
use MediaWiki\Session\Token;
use MediaWiki\Auth\AuthManager;
use MediaWiki\Auth\AuthenticationResponse;
use MediaWiki\Auth\AuthenticationRequest;
use MediaWiki\User\UserIdentity;
use MediaWiki\Logger\LoggerFactory;
use Wikimedia\Assert\Assert;
use Wikimedia\IPSet;
use Wikimedia\ScopedCallback;
use Wikimedia\Rdbms\Database;
use Wikimedia\Rdbms\DBExpectedError;
use Wikimedia\Rdbms\IDatabase;

class User implements IDBAccessObject, UserIdentity {

    const TOKEN_LENGTH = 32;

    const INVALID_TOKEN = '*** INVALID ***';

    const VERSION = 14;

    const GETOPTIONS_EXCLUDE_DEFAULTS = 1;

    const CHECK_USER_RIGHTS = true;

    const IGNORE_USER_RIGHTS = false;

    protected static $mCacheVars = [
        // user table
        'mId',
        'mName',
        'mRealName',
        'mEmail',
        'mTouched',
        'mToken',
        'mEmailAuthenticated',
        'mEmailToken',
        'mEmailTokenExpires',
        'mRegistration',
        'mEditCount',
        // user_groups table
        'mGroupMemberships',
        // user_properties table
        'mOptionOverrides',
        // actor table
        'mActorId',
    ];

    // @{
    public $mId;
    public $mName;
    protected $mActorId;
    public $mRealName;

    public $mEmail;
    public $mTouched;
    protected $mQuickTouched;
    protected $mToken;
    public $mEmailAuthenticated;
    protected $mEmailToken;
    protected $mEmailTokenExpires;
    protected $mRegistration;
    protected $mEditCount;
    protected $mGroupMemberships;
    protected $mOptionOverrides;
    // @}

    // @{
    public $mOptionsLoaded;

    protected $mLoadedItems = [];
    // @}

    public $mFrom;

    protected $mNewtalk;
    protected $mDatePreference;
    public $mBlockedby;
    protected $mHash;
    protected $mBlockreason;
    protected $mEffectiveGroups;
    protected $mImplicitGroups;
    protected $mFormerGroups;
    protected $mGlobalBlock;
    protected $mLocked;
    public $mHideName;
    public $mOptions;

    private $mRequest;

    public $mBlock;

    protected $mAllowUsertalk;

    private $mBlockedFromCreateAccount = false;

    protected $queryFlagsUsed = self::READ_NORMAL;

    public static $idCacheByName = [];

    public function __construct() {
        $this->clearInstanceCache( 'defaults' );
    }

    public function __toString() {
        return (string)$this->getName();
    }

    public function &__get( $name ) {
        // A shortcut for $mRights deprecation phase
        if ( $name === 'mRights' ) {
            $copy = $this->getRights();
            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' ) {
            MediaWikiServices::getInstance()->getPermissionManager()->overrideUserRightsForTesting(
                $this,
                is_null( $value ) ? [] : $value
            );
        } elseif ( !property_exists( $this, $name ) ) {
            $this->$name = $value;
        } else {
            wfLogWarning( 'tried to set non-visible property' );
        }
    }

    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' ? [ 'actor_name' => $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();
                }
                Hooks::run( 'UserLoadAfterLoadFromSession', [ $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() {
        $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
        $data = $cache->getWithSetCallback(
            $this->getCacheKey( $cache ),
            $cache::TTL_HOUR,
            function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
                $setOpts += Database::getCacheSetOptions( wfGetDB( DB_REPLICA ) );
                wfDebug( "User: cache miss for user {$this->mId}\n" );

                $this->loadFromDatabase( self::READ_NORMAL );
                $this->loadGroups();
                $this->loadOptions();

                $data = [];
                foreach ( self::$mCacheVars as $name ) {
                    $data[$name] = $this->$name;
                }

                $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX, $this->mTouched ), $ttl );

                // if a user group membership is about to expire, the cache needs to
                // expire at that time (T163691)
                foreach ( $this->mGroupMemberships 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;
    }

    // @{

    public static function newFromName( $name, $validate = 'valid' ) {
        if ( $validate === true ) {
            $validate = 'valid';
        }
        $name = self::getCanonicalName( $name, $validate );
        if ( $name === false ) {
            return false;
        }

        // Create unloaded user object
        $u = new User;
        $u->mName = $name;
        $u->mFrom = 'name';
        $u->setItemLoaded( 'name' );

        return $u;
    }

    public static function newFromId( $id ) {
        $u = new User;
        $u->mId = $id;
        $u->mFrom = 'id';
        $u->setItemLoaded( 'id' );
        return $u;
    }

    public static function newFromActorId( $id ) {
        $u = new User;
        $u->mActorId = $id;
        $u->mFrom = 'actor';
        $u->setItemLoaded( 'actor' );
        return $u;
    }

    public static function newFromIdentity( UserIdentity $identity ) {
        if ( $identity instanceof User ) {
            return $identity;
        }

        return self::newFromAnyId(
            $identity->getId() === 0 ? null : $identity->getId(),
            $identity->getName() === '' ? null : $identity->getName(),
            $identity->getActorId() === 0 ? null : $identity->getActorId()
        );
    }

    public static function newFromAnyId( $userId, $userName, $actorId, $dbDomain = false ) {
        // Stop-gap solution for the problem described in T222212.
        // Force the User ID and Actor ID to zero for users loaded from the database
        // of another wiki, to prevent subtle data corruption and confusing failure modes.
        if ( $dbDomain !== false ) {
            $userId = 0;
            $actorId = 0;
        }

        $user = new User;
        $user->mFrom = 'defaults';

        if ( $actorId !== null ) {
            $user->mActorId = (int)$actorId;
            if ( $user->mActorId !== 0 ) {
                $user->mFrom = 'actor';
            }
            $user->setItemLoaded( 'actor' );
        }

        if ( $userName !== null && $userName !== '' ) {
            $user->mName = $userName;
            $user->mFrom = 'name';
            $user->setItemLoaded( 'name' );
        }

        if ( $userId !== null ) {
            $user->mId = (int)$userId;
            if ( $user->mId !== 0 ) {
                $user->mFrom = 'id';
            }
            $user->setItemLoaded( 'id' );
        }

        if ( $user->mFrom === 'defaults' ) {
            throw new InvalidArgumentException(
                'Cannot create a user with no name, no ID, and no actor ID'
            );
        }

        return $user;
    }

    public static function newFromConfirmationCode( $code, $flags = 0 ) {
        $db = ( $flags & self::READ_LATEST ) == self::READ_LATEST
            ? wfGetDB( DB_MASTER )
            : wfGetDB( DB_REPLICA );

        $id = $db->selectField(
            'user',
            'user_id',
            [
                'user_email_token' => md5( $code ),
                'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
            ]
        );

        return $id ? self::newFromId( $id ) : null;
    }

    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' => 'valid',
            'create' => true,
            'steal' => false,
        ];

        $name = self::getCanonicalName( $name, $options['validate'] );
        if ( $name === false ) {
            return null;
        }

        $dbr = wfGetDB( 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 = wfGetDB( DB_MASTER );
            $row = $dbw->selectRow(
                $userQuery['tables'],
                $userQuery['fields'],
                [ 'user_name' => $name ],
                __METHOD__,
                [],
                $userQuery['joins']
            );
        }

        if ( !$row ) {
            // No user. Create it?
            return $options['create']
                ? self::createNew( $name, [ 'token' => self::INVALID_TOKEN ] )
                : null;
        }

        $user = self::newFromRow( $row );

        // A user is considered to exist as a non-system user if it can
        // authenticate, or has an email set, or has a non-invalid token.
        if ( $user->mEmail || $user->mToken !== self::INVALID_TOKEN ||
            AuthManager::singleton()->userCanAuthenticate( $name )
        ) {
            // User exists. Steal it?
            if ( !$options['steal'] ) {
                return null;
            }

            AuthManager::singleton()->revokeAccessForUser( $name );

            $user->invalidateEmail();
            $user->mToken = self::INVALID_TOKEN;
            $user->saveSettings();
            SessionManager::singleton()->preventSessionsForUser( $user->getName() );
        }

        return $user;
    }

    // @}

    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 ( is_null( $nt ) ) {
            // Illegal name
            return null;
        }

        if ( !( $flags & self::READ_LATEST ) && array_key_exists( $name, self::$idCacheByName ) ) {
            return is_null( self::$idCacheByName[$name] ) ? 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 )
            || IP::isIPv6( $name );
    }

    public function isIPRange() {
        return IP::isValidRange( $this->mName );
    }

    public static function isValidUserName( $name ) {
        global $wgMaxNameChars;

        if ( $name == ''
            || self::isIP( $name )
            || strpos( $name, '/' ) !== false
            || strlen( $name ) > $wgMaxNameChars
            || $name != MediaWikiServices::getInstance()->getContentLanguage()->ucfirst( $name )
        ) {
            return false;
        }

        // Ensure that the name can't be misresolved as a different title,
        // such as with extra namespace keys at the start.
        $parsed = Title::newFromText( $name );
        if ( is_null( $parsed )
            || $parsed->getNamespace()
            || strcmp( $name, $parsed->getPrefixedText() ) ) {
            return false;
        }

        // Check an additional blacklist of troublemaker characters.
        // Should these be merged into the title char list?
        $unicodeBlacklist = '/[' .
            '\x{0080}-\x{009f}' . # iso-8859-1 control chars
            '\x{00a0}' . # non-breaking space
            '\x{2000}-\x{200f}' . # various whitespace
            '\x{2028}-\x{202f}' . # breaks and control chars
            '\x{3000}' . # ideographic space
            '\x{e000}-\x{f8ff}' . # private use
            ']/u';
        if ( preg_match( $unicodeBlacklist, $name ) ) {
            return false;
        }

        return true;
    }

    public static function isUsableName( $name ) {
        global $wgReservedUsernames;
        // Must be a valid username, obviously ;)
        if ( !self::isValidUserName( $name ) ) {
            return false;
        }

        static $reservedUsernames = false;
        if ( !$reservedUsernames ) {
            $reservedUsernames = $wgReservedUsernames;
            Hooks::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
        }

        // Certain names may be reserved for batch processes.
        foreach ( $reservedUsernames as $reserved ) {
            if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
                $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->plain();
            }
            if ( $reserved == $name ) {
                return false;
            }
        }
        return true;
    }

    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 ) {
        global $wgInvalidUsernameCharacters;

        // Ensure that the username isn't longer than 235 bytes, so that
        // (at least for the builtin skins) user javascript and css files
        // will work. (T25080)
        if ( strlen( $name ) > 235 ) {
            wfDebugLog( 'username', __METHOD__ .
                ": '$name' invalid due to length" );
            return false;
        }

        // Preg yells if you try to give it an empty string
        if ( $wgInvalidUsernameCharacters !== '' &&
            preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name )
        ) {
            wfDebugLog( 'username', __METHOD__ .
                ": '$name' invalid due to wgInvalidUsernameCharacters" );
            return false;
        }

        return self::isUsableName( $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 ( !Hooks::run( 'isValidPassword', [ $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' ) {
        // Force usernames to capital
        $name = MediaWikiServices::getInstance()->getContentLanguage()->ucfirst( $name );

        # Reject names containing '#'; these will be cleaned up
        # with title normalisation, but then it's too late to
        # check elsewhere
        if ( strpos( $name, '#' ) !== false ) {
            return false;
        }

        // Clean up name according to title rules,
        // but only when validation is requested (T14654)
        $t = ( $validate !== false ) ?
            Title::newFromText( $name, NS_USER ) : Title::makeTitle( NS_USER, $name );
        // Check for invalid titles
        if ( is_null( $t ) || $t->getNamespace() !== NS_USER || $t->isExternal() ) {
            return false;
        }

        $name = $t->getText();

        switch ( $validate ) {
            case false:
                break;
            case 'valid':
                if ( !self::isValidUserName( $name ) ) {
                    $name = false;
                }
                break;
            case 'usable':
                if ( !self::isUsableName( $name ) ) {
                    $name = false;
                }
                break;
            case 'creatable':
                if ( !self::isCreatableName( $name ) ) {
                    $name = false;
                }
                break;
            default:
                throw new InvalidArgumentException(
                    'Invalid parameter value for $validate in ' . __METHOD__ );
        }
        return $name;
    }

    public function loadDefaults( $name = false, $actorId = null ) {
        $this->mId = 0;
        $this->mName = $name;
        $this->mActorId = $actorId;
        $this->mRealName = '';
        $this->mEmail = '';
        $this->mOptionOverrides = null;
        $this->mOptionsLoaded = false;

        $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->mGroupMemberships = [];

        Hooks::run( 'UserLoadDefaults', [ $this, $name ] );
    }

    public function isItemLoaded( $item, $all = 'all' ) {
        return ( $this->mLoadedItems === true && $all === 'all' ) ||
            ( isset( $this->mLoadedItems[$item] ) && $this->mLoadedItems[$item] === true );
    }

    protected 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->isLoggedIn() ) {
            $this->loadFromUserObject( $user );

            // If this user is autoblocked, set a cookie to track the block. This has to be done on
            // every session load, because an autoblocked editor might not edit again from the same
            // IP address after being blocked.
            MediaWikiServices::getInstance()->getBlockManager()->trackBlockWithCookie( $this );

            // 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 trackBlockWithCookie() {
        MediaWikiServices::getInstance()->getBlockManager()->trackBlockWithCookie( $this );
    }

    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;
        Hooks::run( 'UserLoadFromDatabase', [ $this, &$s ] );

        if ( $s !== false ) {
            // Initialise user table data
            $this->loadFromRow( $s );
            $this->mGroupMemberships = null; // deferred
            $this->getEditCount(); // revalidation for nulls
            return true;
        }

        // Invalid user_id
        $this->mId = 0;
        $this->loadDefaults();

        return false;
    }

    protected function loadFromRow( $row, $data = null ) {
        if ( !is_object( $row ) ) {
            throw new InvalidArgumentException( '$row must be an object' );
        }

        $all = true;

        $this->mGroupMemberships = null; // deferred

        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'] ) ) {
                if ( $data['user_groups'] === [] ) {
                    $this->mGroupMemberships = [];
                } else {
                    $firstGroup = reset( $data['user_groups'] );
                    if ( is_array( $firstGroup ) || is_object( $firstGroup ) ) {
                        $this->mGroupMemberships = [];
                        foreach ( $data['user_groups'] as $row ) {
                            $ugm = UserGroupMembership::newFromRow( (object)$row );
                            $this->mGroupMemberships[$ugm->getGroup()] = $ugm;
                        }
                    }
                }
            }
            if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
                $this->loadOptions( $data['user_properties'] );
            }
        }
    }

    protected function loadFromUserObject( $user ) {
        $user->load();
        foreach ( self::$mCacheVars as $var ) {
            $this->$var = $user->$var;
        }
    }

    private function loadGroups() {
        if ( is_null( $this->mGroupMemberships ) ) {
            $db = ( $this->queryFlagsUsed & self::READ_LATEST )
                ? wfGetDB( DB_MASTER )
                : wfGetDB( DB_REPLICA );
            $this->mGroupMemberships = UserGroupMembership::getMembershipsForUser(
                $this->mId, $db );
        }
    }

    public function addAutopromoteOnceGroups( $event ) {
        global $wgAutopromoteOnceLogInRC;

        if ( wfReadOnly() || !$this->getId() ) {
            return [];
        }

        $toPromote = Autopromote::getAutopromoteOnceGroups( $this, $event );
        if ( $toPromote === [] ) {
            return [];
        }

        if ( !$this->checkAndSetTouched() ) {
            return []; // raced out (bug T48834)
        }

        $oldGroups = $this->getGroups(); // previous groups
        $oldUGMs = $this->getGroupMemberships();
        foreach ( $toPromote as $group ) {
            $this->addGroup( $group );
        }
        $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
        $newUGMs = $this->getGroupMemberships();

        // update groups in external authentication database
        Hooks::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );

        $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
        $logEntry->setPerformer( $this );
        $logEntry->setTarget( $this->getUserPage() );
        $logEntry->setParameters( [
            '4::oldgroups' => $oldGroups,
            '5::newgroups' => $newGroups,
        ] );
        $logid = $logEntry->insert();
        if ( $wgAutopromoteOnceLogInRC ) {
            $logEntry->publish( $logid );
        }

        return $toPromote;
    }

    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;
    }

    protected 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->mNewtalk = -1;
        $this->mDatePreference = null;
        $this->mBlockedby = -1; # Unset
        $this->mHash = false;
        $this->mEffectiveGroups = null;
        $this->mImplicitGroups = null;
        $this->mGroupMemberships = null;
        $this->mOptions = null;
        $this->mOptionsLoaded = false;
        $this->mEditCount = null;

        // Replacement of former `$this->mRights = null` line
        if ( $wgFullyInitialised && $this->mFrom ) {
            MediaWikiServices::getInstance()->getPermissionManager()->invalidateUsersRightsCache(
                $this
            );
        }

        if ( $reloadFrom ) {
            $this->mLoadedItems = [];
            $this->mFrom = $reloadFrom;
        }
    }

    private static $defOpt = null;
    private static $defOptLang = null;

    public static function resetGetDefaultOptionsForTestsOnly() {
        Assert::invariant( defined( 'MW_PHPUNIT_TEST' ), 'Unit tests only' );
        self::$defOpt = null;
        self::$defOptLang = null;
    }

    public static function getDefaultOptions() {
        global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgDefaultSkin;

        $contLang = MediaWikiServices::getInstance()->getContentLanguage();
        if ( self::$defOpt !== null && self::$defOptLang === $contLang->getCode() ) {
            // The content language does not change (and should not change) mid-request, but the
            // unit tests change it anyway, and expect this method to return values relevant to the
            // current content language.
            return self::$defOpt;
        }

        self::$defOpt = $wgDefaultUserOptions;
        // Default language setting
        self::$defOptLang = $contLang->getCode();
        self::$defOpt['language'] = self::$defOptLang;
        foreach ( LanguageConverter::$languagesWithVariants as $langCode ) {
            if ( $langCode === $contLang->getCode() ) {
                self::$defOpt['variant'] = $langCode;
            } else {
                self::$defOpt["variant-$langCode"] = $langCode;
            }
        }

        // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
        // since extensions may change the set of searchable namespaces depending
        // on user groups/permissions.
        foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
            self::$defOpt['searchNs' . $nsnum] = (bool)$val;
        }
        self::$defOpt['skin'] = Skin::normalizeKey( $wgDefaultSkin );

        Hooks::run( 'UserGetDefaultOptions', [ &self::$defOpt ] );

        return self::$defOpt;
    }

    public static function getDefaultOption( $opt ) {
        $defOpts = self::getDefaultOptions();
        return $defOpts[$opt] ?? null;
    }

    private function getBlockedStatus( $fromReplica = true ) {
        if ( $this->mBlockedby != -1 ) {
            return;
        }

        wfDebug( __METHOD__ . ": checking...\n" );

        // 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;

        // 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()
            : IP::sanitizeIP( $sessionUser->getRequest()->getIP() );

        if ( $this->getName() === $globalUserName ) {
            // This is the global user, so we need to pass the request
            $request = $this->getRequest();
        }

        // @phan-suppress-next-line PhanAccessMethodInternal It's the only allowed use
        $block = MediaWikiServices::getInstance()->getBlockManager()->getUserBlock(
            $this,
            $request,
            $fromReplica
        );

        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;
        }

        // Avoid PHP 7.1 warning of passing $this by reference
        $thisUser = $this;
        // Extensions
        Hooks::run( 'GetBlockedStatus', [ &$thisUser ], '1.34' );
    }

    public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
        return MediaWikiServices::getInstance()->getBlockManager()
            ->isDnsBlacklisted( $ip, $checkWhitelist );
    }

    public function inDnsBlacklist( $ip, $bases ) {
        wfDeprecated( __METHOD__, '1.34' );

        $found = false;
        // @todo FIXME: IPv6 ???  (https://bugs.php.net/bug.php?id=33170)
        if ( IP::isIPv4( $ip ) ) {
            // Reverse IP, T23255
            $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );

            foreach ( (array)$bases as $base ) {
                // Make hostname
                // If we have an access key, use that too (ProjectHoneypot, etc.)
                $basename = $base;
                if ( is_array( $base ) ) {
                    if ( count( $base ) >= 2 ) {
                        // Access key is 1, base URL is 0
                        $host = "{$base[1]}.$ipReversed.{$base[0]}";
                    } else {
                        $host = "$ipReversed.{$base[0]}";
                    }
                    $basename = $base[0];
                } else {
                    $host = "$ipReversed.$base";
                }

                // Send query
                $ipList = gethostbynamel( $host );

                if ( $ipList ) {
                    wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
                    $found = true;
                    break;
                }

                wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
            }
        }

        return $found;
    }

    public static function isLocallyBlockedProxy( $ip ) {
        wfDeprecated( __METHOD__, '1.34' );

        global $wgProxyList;

        if ( !$wgProxyList ) {
            return false;
        }

        if ( !is_array( $wgProxyList ) ) {
            // Load values from the specified file
            $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
        }

        $resultProxyList = [];
        $deprecatedIPEntries = [];

        // backward compatibility: move all ip addresses in keys to values
        foreach ( $wgProxyList as $key => $value ) {
            $keyIsIP = IP::isIPAddress( $key );
            $valueIsIP = IP::isIPAddress( $value );
            if ( $keyIsIP && !$valueIsIP ) {
                $deprecatedIPEntries[] = $key;
                $resultProxyList[] = $key;
            } elseif ( $keyIsIP && $valueIsIP ) {
                $deprecatedIPEntries[] = $key;
                $resultProxyList[] = $key;
                $resultProxyList[] = $value;
            } else {
                $resultProxyList[] = $value;
            }
        }

        if ( $deprecatedIPEntries ) {
            wfDeprecated(
                'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
                implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
        }

        $proxyListIPSet = new IPSet( $resultProxyList );
        return $proxyListIPSet->match( $ip );
    }

    public function isPingLimitable() {
        global $wgRateLimitsExcludedIPs;
        if ( IP::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 ) {
        // Avoid PHP 7.1 warning of passing $this by reference
        $user = $this;
        // Call the 'PingLimiter' hook
        $result = false;
        if ( !Hooks::run( 'PingLimiter', [ &$user, $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;
        }

        $keys = [];
        $id = $this->getId();
        $userLimit = false;
        $isNewbie = $this->isNewbie();
        $cache = ObjectCache::getLocalClusterInstance();

        if ( $id == 0 ) {
            // limits for anons
            if ( isset( $limits['anon'] ) ) {
                $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
            }
        } elseif ( isset( $limits['user'] ) ) {
            // limits for logged-in users
            $userLimit = $limits['user'];
        }

        // limits for anons and for newbie logged-in users
        if ( $isNewbie ) {
            // ip-based limits
            if ( isset( $limits['ip'] ) ) {
                $ip = $this->getRequest()->getIP();
                $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
            }
            // subnet-based limits
            if ( isset( $limits['subnet'] ) ) {
                $ip = $this->getRequest()->getIP();
                $subnet = IP::getSubnet( $ip );
                if ( $subnet !== false ) {
                    $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
                }
            }
        }

        // Check for group-specific permissions
        // If more than one group applies, use the group with the highest limit ratio (max/period)
        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];
                }
            }
        }

        // limits for newbie logged-in users (override all the normal user limits)
        if ( $id !== 0 && $isNewbie && isset( $limits['newbie'] ) ) {
            $userLimit = $limits['newbie'];
        }

        // 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;
            wfDebug( __METHOD__ . ": effective user limit: $max in {$period}s\n" );
            $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["mediawiki: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 = IP::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["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
                }
            }
        }

        $triggered = false;
        foreach ( $keys as $key => $limit ) {
            // 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;
            $summary = "(limit $max in {$period}s)";
            $count = $cache->get( $key );
            // Already pinged?
            if ( $count && $count >= $max ) {
                wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
                    "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
                $triggered = true;
            } else {
                wfDebug( __METHOD__ . ": adding record for $key $summary\n" );
                if ( $incrBy > 0 ) {
                    $cache->add( $key, 0, intval( $period ) ); // first ping
                }
            }
            if ( $incrBy > 0 ) {
                $cache->incrWithInit( $key, (int)$period, $incrBy, $incrBy );
            }
        }

        return $triggered;
    }

    public function isBlocked( $fromReplica = true ) {
        return $this->getBlock( $fromReplica ) instanceof AbstractBlock &&
            $this->getBlock()->appliesToRight( 'edit' );
    }

    public function getBlock( $fromReplica = true ) {
        $this->getBlockedStatus( $fromReplica );
        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 ( IP::isIPAddress( $this->getName() ) ) {
            $ip = $this->getName();
        } elseif ( !$ip ) {
            $ip = $this->getRequest()->getIP();
        }
        // Avoid PHP 7.1 warning of passing $this by reference
        $user = $this;
        $blocked = false;
        $block = null;
        Hooks::run( 'UserIsBlockedGlobally', [ &$user, $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;
        Hooks::run( 'UserIsLocked', [ $this, &$this->mLocked ] );
        return $this->mLocked;
    }

    public function isHidden() {
        if ( $this->mHideName !== null ) {
            return (bool)$this->mHideName;
        }
        $this->getBlockedStatus();
        if ( !$this->mHideName ) {
            // Reset for hook
            $this->mHideName = false;
            Hooks::run( 'UserIsHidden', [ $this, &$this->mHideName ], '1.34' );
        }
        return (bool)$this->mHideName;
    }

    public function getId() {
        if ( $this->mId === null && $this->mName !== null &&
            ( self::isIP( $this->mName ) || ExternalUserNames::isExternal( $this->mName ) )
        ) {
            // Special case, we know the user is anonymous
            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() {
        if ( $this->isItemLoaded( 'name', 'only' ) ) {
            // Special case optimisation
            return $this->mName;
        }

        $this->load();
        if ( $this->mName === false ) {
            // Clean up IPs
            $this->mName = IP::sanitizeIP( $this->getRequest()->getIP() );
        }

        return $this->mName;
    }

    public function setName( $str ) {
        $this->load();
        $this->mName = $str;
    }

    public function getActorId( IDatabase $dbw = null ) {
        if ( !$this->isItemLoaded( 'actor' ) ) {
            $this->load();
        }

        if ( !$this->mActorId && $dbw ) {
            $q = [
                'actor_user' => $this->getId() ?: null,
                'actor_name' => (string)$this->getName(),
            ];
            if ( $q['actor_user'] === null && self::isUsableName( $q['actor_name'] ) ) {
                throw new CannotCreateActorException(
                    'Cannot create an actor for a usable name that is not an existing user'
                );
            }
            if ( $q['actor_name'] === '' ) {
                throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
            }
            $dbw->insert( 'actor', $q, __METHOD__, [ 'IGNORE' ] );
            if ( $dbw->affectedRows() ) {
                $this->mActorId = (int)$dbw->insertId();
            } else {
                // Outdated cache?
                // Use LOCK IN SHARE MODE to bypass any MySQL REPEATABLE-READ snapshot.
                $this->mActorId = (int)$dbw->selectField(
                    'actor',
                    'actor_id',
                    $q,
                    __METHOD__,
                    [ 'LOCK IN SHARE MODE' ]
                );
                if ( !$this->mActorId ) {
                    throw new CannotCreateActorException(
                        "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
                    );
                }
            }
            $this->invalidateCache();
            $this->setItemLoaded( 'actor' );
        }

        return (int)$this->mActorId;
    }

    public function getTitleKey() {
        return str_replace( ' ', '_', $this->getName() );
    }

    public function getNewtalk() {
        $this->load();

        // Load the newtalk status if it is unloaded (mNewtalk=-1)
        if ( $this->mNewtalk === -1 ) {
            $this->mNewtalk = false; # reset talk page status

            // Check memcached separately for anons, who have no
            // entire User object stored in there.
            if ( !$this->mId ) {
                global $wgDisableAnonTalk;
                if ( $wgDisableAnonTalk ) {
                    // Anon newtalk disabled by configuration.
                    $this->mNewtalk = false;
                } else {
                    $this->mNewtalk = $this->checkNewtalk( 'user_ip', $this->getName() );
                }
            } else {
                $this->mNewtalk = $this->checkNewtalk( 'user_id', $this->mId );
            }
        }

        return (bool)$this->mNewtalk;
    }

    public function getNewMessageLinks() {
        // Avoid PHP 7.1 warning of passing $this by reference
        $user = $this;
        $talks = [];
        if ( !Hooks::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
            return $talks;
        }

        if ( !$this->getNewtalk() ) {
            return [];
        }
        $utp = $this->getTalkPage();
        $dbr = wfGetDB( DB_REPLICA );
        // Get the "last viewed rev" timestamp from the oldest message notification
        $timestamp = $dbr->selectField( 'user_newtalk',
            'MIN(user_last_timestamp)',
            $this->isAnon() ? [ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
            __METHOD__ );
        $rev = $timestamp ? Revision::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
        return [
            [
                'wiki' => WikiMap::getWikiIdFromDbDomain( WikiMap::getCurrentWikiDbDomain() ),
                'link' => $utp->getLocalURL(),
                'rev' => $rev
            ]
        ];
    }

    public function getNewMessageRevisionId() {
        $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;
    }

    protected function checkNewtalk( $field, $id ) {
        $dbr = wfGetDB( DB_REPLICA );

        $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__ );

        return $ok !== false;
    }

    protected function updateNewtalk( $field, $id, $curRev = null ) {
        // Get timestamp of the talk page revision prior to the current one
        $prevRev = $curRev ? $curRev->getPrevious() : false;
        $ts = $prevRev ? $prevRev->getTimestamp() : null;
        // Mark the user as having new messages since this revision
        $dbw = wfGetDB( DB_MASTER );
        $dbw->insert( 'user_newtalk',
            [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
            __METHOD__,
            [ 'IGNORE' ] );
        if ( $dbw->affectedRows() ) {
            wfDebug( __METHOD__ . ": set on ($field, $id)\n" );
            return true;
        }

        wfDebug( __METHOD__ . " already set ($field, $id)\n" );
        return false;
    }

    protected function deleteNewtalk( $field, $id ) {
        $dbw = wfGetDB( DB_MASTER );
        $dbw->delete( 'user_newtalk',
            [ $field => $id ],
            __METHOD__ );
        if ( $dbw->affectedRows() ) {
            wfDebug( __METHOD__ . ": killed on ($field, $id)\n" );
            return true;
        }

        wfDebug( __METHOD__ . ": already gone ($field, $id)\n" );
        return false;
    }

    public function setNewtalk( $val, $curRev = null ) {
        if ( wfReadOnly() ) {
            return;
        }

        $this->load();
        $this->mNewtalk = $val;

        if ( $this->isAnon() ) {
            $field = 'user_ip';
            $id = $this->getName();
        } else {
            $field = 'user_id';
            $id = $this->getId();
        }

        if ( $val ) {
            $changed = $this->updateNewtalk( $field, $id, $curRev );
        } else {
            $changed = $this->deleteNewtalk( $field, $id );
        }

        if ( $changed ) {
            $this->invalidateCache();
        }
    }

    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(
                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 setPassword( $str ) {
        wfDeprecated( __METHOD__, '1.27' );
        return $this->setPasswordInternal( $str );
    }

    public function setInternalPassword( $str ) {
        wfDeprecated( __METHOD__, '1.27' );
        $this->setPasswordInternal( $str );
    }

    private function setPasswordInternal( $str ) {
        $manager = AuthManager::singleton();

        // If the user doesn't exist yet, fail
        if ( !$manager->userExists( $this->getName() ) ) {
            throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
        }

        $status = $this->changeAuthenticationData( [
            'username' => $this->getName(),
            'password' => $str,
            'retype' => $str,
        ] );
        if ( !$status->isGood() ) {
            \MediaWiki\Logger\LoggerFactory::getInstance( 'authentication' )
                ->info( __METHOD__ . ': Password change rejected: '
                    . $status->getWikiText( null, null, 'en' ) );
            return false;
        }

        $this->setOption( 'watchlisttoken', false );
        SessionManager::singleton()->invalidateSessionsForUser( $this );

        return true;
    }

    public function changeAuthenticationData( array $data ) {
        $manager = AuthManager::singleton();
        $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();
        Hooks::run( 'UserGetEmail', [ $this, &$this->mEmail ] );
        return $this->mEmail;
    }

    public function getEmailAuthenticationTimestamp() {
        $this->load();
        Hooks::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated ] );
        return $this->mEmailAuthenticated;
    }

    public function setEmail( $str ) {
        $this->load();
        if ( $str == $this->mEmail ) {
            return;
        }
        $this->invalidateEmail();
        $this->mEmail = $str;
        Hooks::run( 'UserSetEmail', [ $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 ) {
        global $wgHiddenPrefs;
        $this->loadOptions();

        # We want 'disabled' preferences to always behave as the default value for
        # users, even if they have set the option explicitly in their settings (ie they
        # set it, and then it was disabled removing their ability to change it).  But
        # we don't want to erase the preferences in the database in case the preference
        # is re-enabled again.  So don't touch $mOptions, just override the returned value
        if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
            return self::getDefaultOption( $oname );
        }

        if ( array_key_exists( $oname, $this->mOptions ) ) {
            return $this->mOptions[$oname];
        }

        return $defaultOverride;
    }

    public function getOptions( $flags = 0 ) {
        global $wgHiddenPrefs;
        $this->loadOptions();
        $options = $this->mOptions;

        # We want 'disabled' preferences to always behave as the default value for
        # users, even if they have set the option explicitly in their settings (ie they
        # set it, and then it was disabled removing their ability to change it).  But
        # we don't want to erase the preferences in the database in case the preference
        # is re-enabled again.  So don't touch $mOptions, just override the returned value
        foreach ( $wgHiddenPrefs as $pref ) {
            $default = self::getDefaultOption( $pref );
            if ( $default !== null ) {
                $options[$pref] = $default;
            }
        }

        if ( $flags & self::GETOPTIONS_EXCLUDE_DEFAULTS ) {
            $options = array_diff_assoc( $options, self::getDefaultOptions() );
        }

        return $options;
    }

    public function getBoolOption( $oname ) {
        return (bool)$this->getOption( $oname );
    }

    public function getIntOption( $oname, $defaultOverride = 0 ) {
        $val = $this->getOption( $oname );
        if ( $val == '' ) {
            $val = $defaultOverride;
        }
        return intval( $val );
    }

    public function setOption( $oname, $val ) {
        $this->loadOptions();

        // Explicitly NULL values should refer to defaults
        if ( is_null( $val ) ) {
            $val = self::getDefaultOption( $oname );
        }

        $this->mOptions[$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 [
            'registered',
            'registered-multiselect',
            'registered-checkmatrix',
            'userjs',
            'special',
            'unused'
        ];
    }

    public function getOptionKinds( IContextSource $context, $options = null ) {
        $this->loadOptions();
        if ( $options === null ) {
            $options = $this->mOptions;
        }

        $preferencesFactory = MediaWikiServices::getInstance()->getPreferencesFactory();
        $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
        $mapping = [];

        // Pull out the "special" options, so they don't get converted as
        // multiselect or checkmatrix.
        $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
        foreach ( $specialOptions as $name => $value ) {
            unset( $prefs[$name] );
        }

        // Multiselect and checkmatrix options are stored in the database with
        // one key per option, each having a boolean value. Extract those keys.
        $multiselectOptions = [];
        foreach ( $prefs as $name => $info ) {
            if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
                    ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField::class ) ) {
                $opts = HTMLFormField::flattenOptions( $info['options'] );
                $prefix = $info['prefix'] ?? $name;

                foreach ( $opts as $value ) {
                    $multiselectOptions["$prefix$value"] = true;
                }

                unset( $prefs[$name] );
            }
        }
        $checkmatrixOptions = [];
        foreach ( $prefs as $name => $info ) {
            if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
                    ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix::class ) ) {
                $columns = HTMLFormField::flattenOptions( $info['columns'] );
                $rows = HTMLFormField::flattenOptions( $info['rows'] );
                $prefix = $info['prefix'] ?? $name;

                foreach ( $columns as $column ) {
                    foreach ( $rows as $row ) {
                        $checkmatrixOptions["$prefix$column-$row"] = true;
                    }
                }

                unset( $prefs[$name] );
            }
        }

        // $value is ignored
        foreach ( $options as $key => $value ) {
            if ( isset( $prefs[$key] ) ) {
                $mapping[$key] = 'registered';
            } elseif ( isset( $multiselectOptions[$key] ) ) {
                $mapping[$key] = 'registered-multiselect';
            } elseif ( isset( $checkmatrixOptions[$key] ) ) {
                $mapping[$key] = 'registered-checkmatrix';
            } elseif ( isset( $specialOptions[$key] ) ) {
                $mapping[$key] = 'special';
            } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
                $mapping[$key] = 'userjs';
            } else {
                $mapping[$key] = 'unused';
            }
        }

        return $mapping;
    }

    public function resetOptions(
        $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
        IContextSource $context = null
    ) {
        $this->load();
        $defaultOptions = self::getDefaultOptions();

        if ( !is_array( $resetKinds ) ) {
            $resetKinds = [ $resetKinds ];
        }

        if ( in_array( 'all', $resetKinds ) ) {
            $newOptions = $defaultOptions;
        } else {
            if ( $context === null ) {
                $context = RequestContext::getMain();
            }

            $optionKinds = $this->getOptionKinds( $context );
            $resetKinds = array_intersect( $resetKinds, self::listOptionKinds() );
            $newOptions = [];

            // Use default values for the options that should be deleted, and
            // copy old values for the ones that shouldn't.
            foreach ( $this->mOptions as $key => $value ) {
                if ( in_array( $optionKinds[$key], $resetKinds ) ) {
                    if ( array_key_exists( $key, $defaultOptions ) ) {
                        $newOptions[$key] = $defaultOptions[$key];
                    }
                } else {
                    $newOptions[$key] = $value;
                }
            }
        }

        Hooks::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions, $resetKinds ] );

        $this->mOptions = $newOptions;
        $this->mOptionsLoaded = true;
    }

    public function getDatePreference() {
        // Important migration for old data rows
        if ( is_null( $this->mDatePreference ) ) {
            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 $wgSecureLogin;
        if ( !$wgSecureLogin ) {
            return false;
        }

        $https = $this->getBoolOption( 'prefershttps' );
        Hooks::run( 'UserRequiresHTTPS', [ $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() {
        $this->load();
        $this->loadGroups();
        return array_keys( $this->mGroupMemberships );
    }

    public function getGroupMemberships() {
        $this->load();
        $this->loadGroups();
        return $this->mGroupMemberships;
    }

    public function getEffectiveGroups( $recache = false ) {
        if ( $recache || is_null( $this->mEffectiveGroups ) ) {
            $this->mEffectiveGroups = array_unique( array_merge(
                $this->getGroups(), // explicit groups
                $this->getAutomaticGroups( $recache ) // implicit groups
            ) );
            // Avoid PHP 7.1 warning of passing $this by reference
            $user = $this;
            // Hook for additional groups
            Hooks::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups ] );
            // Force reindexation of groups when a hook has unset one of them
            $this->mEffectiveGroups = array_values( array_unique( $this->mEffectiveGroups ) );
        }
        return $this->mEffectiveGroups;
    }

    public function getAutomaticGroups( $recache = false ) {
        if ( $recache || is_null( $this->mImplicitGroups ) ) {
            $this->mImplicitGroups = [ '*' ];
            if ( $this->getId() ) {
                $this->mImplicitGroups[] = 'user';

                $this->mImplicitGroups = array_unique( array_merge(
                    $this->mImplicitGroups,
                    Autopromote::getAutopromoteGroups( $this )
                ) );
            }
            if ( $recache ) {
                // Assure data consistency with rights/groups,
                // as getEffectiveGroups() depends on this function
                $this->mEffectiveGroups = null;
            }
        }
        return $this->mImplicitGroups;
    }

    public function getFormerGroups() {
        $this->load();

        if ( is_null( $this->mFormerGroups ) ) {
            $db = ( $this->queryFlagsUsed & self::READ_LATEST )
                ? wfGetDB( DB_MASTER )
                : wfGetDB( DB_REPLICA );
            $res = $db->select( 'user_former_groups',
                [ 'ufg_group' ],
                [ 'ufg_user' => $this->mId ],
                __METHOD__ );
            $this->mFormerGroups = [];
            foreach ( $res as $row ) {
                $this->mFormerGroups[] = $row->ufg_group;
            }
        }

        return $this->mFormerGroups;
    }

    public function getEditCount() {
        if ( !$this->getId() ) {
            return null;
        }

        if ( $this->mEditCount === null ) {
            /* Populate the count, if it has not been populated yet */
            $dbr = wfGetDB( DB_REPLICA );
            // check if the user_editcount field has been initialized
            $count = $dbr->selectField(
                'user', 'user_editcount',
                [ 'user_id' => $this->mId ],
                __METHOD__
            );

            if ( $count === null ) {
                // it has not been initialized. do so.
                $count = $this->initEditCountInternal( $dbr );
            }
            $this->mEditCount = $count;
        }
        return (int)$this->mEditCount;
    }

    public function addGroup( $group, $expiry = null ) {
        $this->load();
        $this->loadGroups();

        if ( $expiry ) {
            $expiry = wfTimestamp( TS_MW, $expiry );
        }

        if ( !Hooks::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
            return false;
        }

        // create the new UserGroupMembership and put it in the DB
        $ugm = new UserGroupMembership( $this->mId, $group, $expiry );
        if ( !$ugm->insert( true ) ) {
            return false;
        }

        $this->mGroupMemberships[$group] = $ugm;

        // Refresh the groups caches, and clear the rights cache so it will be
        // refreshed on the next call to $this->getRights().
        $this->getEffectiveGroups( true );
        MediaWikiServices::getInstance()->getPermissionManager()->invalidateUsersRightsCache( $this );
        $this->invalidateCache();

        return true;
    }

    public function removeGroup( $group ) {
        $this->load();

        if ( !Hooks::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
            return false;
        }

        $ugm = UserGroupMembership::getMembership( $this->mId, $group );
        // delete the membership entry
        if ( !$ugm || !$ugm->delete() ) {
            return false;
        }

        $this->loadGroups();
        unset( $this->mGroupMemberships[$group] );

        // Refresh the groups caches, and clear the rights cache so it will be
        // refreshed on the next call to $this->getRights().
        $this->getEffectiveGroups( true );
        MediaWikiServices::getInstance()->getPermissionManager()->invalidateUsersRightsCache( $this );
        $this->invalidateCache();

        return true;
    }

    public function isRegistered() {
        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;
        Hooks::run( "UserIsBot", [ $this, &$isBot ] );

        return $isBot;
    }

    public function isAllowedAny() {
        return MediaWikiServices::getInstance()
            ->getPermissionManager()
            ->userHasAnyRight( $this, ...func_get_args() );
    }

    public function isAllowedAll() {
        return MediaWikiServices::getInstance()
            ->getPermissionManager()
            ->userHasAllRights( $this, ...func_get_args() );
    }

    public function isAllowed( $action = '' ) {
        return MediaWikiServices::getInstance()->getPermissionManager()
            ->userHasRight( $this, $action );
    }

    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;
        }

        global $wgRequest;
        return $wgRequest;
    }

    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 addWatch( $title, $checkRights = self::CHECK_USER_RIGHTS ) {
        if ( !$checkRights || $this->isAllowed( 'editmywatchlist' ) ) {
            MediaWikiServices::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
                $this,
                [ $title->getSubjectPage(), $title->getTalkPage() ]
            );
        }
        $this->invalidateCache();
    }

    public function removeWatch( $title, $checkRights = self::CHECK_USER_RIGHTS ) {
        if ( !$checkRights || $this->isAllowed( 'editmywatchlist' ) ) {
            $store = MediaWikiServices::getInstance()->getWatchedItemStore();
            $store->removeWatch( $this, $title->getSubjectPage() );
            $store->removeWatch( $this, $title->getTalkPage() );
        }
        $this->invalidateCache();
    }

    public function clearNotification( &$title, $oldid = 0 ) {
        global $wgUseEnotif, $wgShowUpdatedMarker;

        // Do nothing if the database is locked to writes
        if ( wfReadOnly() ) {
            return;
        }

        // Do nothing if not allowed to edit the watchlist
        if ( !$this->isAllowed( 'editmywatchlist' ) ) {
            return;
        }

        // If we're working on user's talk page, we should update the talk page message indicator
        if ( $title->getNamespace() == NS_USER_TALK && $title->getText() == $this->getName() ) {
            // Avoid PHP 7.1 warning of passing $this by reference
            $user = $this;
            if ( !Hooks::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
                return;
            }

            // Try to update the DB post-send and only if needed...
            DeferredUpdates::addCallableUpdate( function () use ( $title, $oldid ) {
                if ( !$this->getNewtalk() ) {
                    return; // no notifications to clear
                }

                // Delete the last notifications (they stack up)
                $this->setNewtalk( false );

                // If there is a new, unseen, revision, use its timestamp
                if ( $oldid ) {
                    $rl = MediaWikiServices::getInstance()->getRevisionLookup();
                    $oldRev = $rl->getRevisionById( $oldid, Title::READ_LATEST );
                    if ( $oldRev ) {
                        $newRev = $rl->getNextRevision( $oldRev );
                        if ( $newRev ) {
                            // TODO: actually no need to wrap in a revision,
                            // setNewtalk really only needs a RevRecord
                            $this->setNewtalk( true, new Revision( $newRev ) );
                        }
                    }
                }
            } );
        }

        if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
            return;
        }

        if ( $this->isAnon() ) {
            // Nothing else to do...
            return;
        }

        // Only update the timestamp if the page is being watched.
        // The query to find out if it is watched is cached both in memcached and per-invocation,
        // and when it does have to be executed, it can be on a replica DB
        // If this is the user's newtalk page, we always update the timestamp
        $force = '';
        if ( $title->getNamespace() == NS_USER_TALK && $title->getText() == $this->getName() ) {
            $force = 'force';
        }

        MediaWikiServices::getInstance()->getWatchedItemStore()
            ->resetNotificationTimestamp( $this, $title, $force, $oldid );
    }

    public function clearAllNotifications() {
        global $wgUseEnotif, $wgShowUpdatedMarker;
        // Do nothing if not allowed to edit the watchlist
        if ( wfReadOnly() || !$this->isAllowed( 'editmywatchlist' ) ) {
            return;
        }

        if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
            $this->setNewtalk( false );
            return;
        }

        $id = $this->getId();
        if ( !$id ) {
            return;
        }

        $watchedItemStore = MediaWikiServices::getInstance()->getWatchedItemStore();
        $watchedItemStore->resetAllNotificationTimestampsForUser( $this );

        // We also need to clear here the "you have new message" notification for the own
        // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
    }

    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 ( $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 ( Hooks::run( 'UserLogout', [ &$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;
        $this->saveOptions();

        Hooks::run( 'UserSaveSettings', [ $this ] );
        $this->clearSharedCache( 'changed' );
        $this->getUserPage()->purgeSquid();
    }

    public function idForName( $flags = 0 ) {
        $s = trim( $this->getName() );
        if ( $s === '' ) {
            return 0;
        }

        $db = ( ( $flags & self::READ_LATEST ) == self::READ_LATEST )
            ? wfGetDB( DB_MASTER )
            : wfGetDB( DB_REPLICA );

        $options = ( ( $flags & self::READ_LOCKING ) == self::READ_LOCKING )
            ? [ 'LOCK IN SHARE MODE' ]
            : [];

        $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'] ) ) {
            $user->mOptions = $params['options'] + (array)$user->mOptions;
            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();

        $this->saveOptions();
        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->isLoggedIn() && $this->getBlock() ) {
            return $this->spreadBlock();
        }

        return false;
    }

    protected function spreadBlock() {
        wfDebug( __METHOD__ . "()\n" );
        $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 checkPassword( $password ) {
        wfDeprecated( __METHOD__, '1.27' );

        $manager = AuthManager::singleton();
        $reqs = AuthenticationRequest::loadRequestsFromSubmission(
            $manager->getAuthenticationRequests( AuthManager::ACTION_LOGIN ),
            [
                'username' => $this->getName(),
                'password' => $password,
            ]
        );
        $res = $manager->beginAuthentication( $reqs, 'null:' );
        switch ( $res->status ) {
            case AuthenticationResponse::PASS:
                return true;
            case AuthenticationResponse::FAIL:
                // Hope it's not a PreAuthenticationProvider that failed...
                LoggerFactory::getInstance( 'authentication' )
                    ->info( __METHOD__ . ': Authentication failed: ' . $res->message->plain() );
                return false;
            default:
                throw new BadMethodCallException(
                    'AuthManager returned a response unsupported by ' . __METHOD__
                );
        }
    }

    public function checkTemporaryPassword( $plaintext ) {
        wfDeprecated( __METHOD__, '1.27' );
        // Can't check the temporary password individually.
        return $this->checkPassword( $plaintext );
    }

    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
        ];

        Hooks::run( 'UserSendConfirmationMail', [ $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() );
            Hooks::run( 'ConfirmEmailComplete', [ $this ] );
        }
        return true;
    }

    public function invalidateEmail() {
        $this->load();
        $this->mEmailToken = null;
        $this->mEmailTokenExpires = null;
        $this->setEmailAuthenticationTimestamp( null );
        $this->mEmail = '';
        Hooks::run( 'InvalidateEmailComplete', [ $this ] );
        return true;
    }

    public function setEmailAuthenticationTimestamp( $timestamp ) {
        $this->load();
        $this->mEmailAuthenticated = $timestamp;
        Hooks::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated ] );
    }

    public function canSendEmail() {
        global $wgEnableEmail, $wgEnableUserEmail;
        if ( !$wgEnableEmail || !$wgEnableUserEmail || !$this->isAllowed( 'sendemail' ) ) {
            return false;
        }
        $canSend = $this->isEmailConfirmed();
        // Avoid PHP 7.1 warning of passing $this by reference
        $user = $this;
        Hooks::run( 'UserCanSendEmail', [ &$user, &$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 ( Hooks::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
            if ( $this->isAnon() ) {
                return false;
            }
            if ( !Sanitizer::validateEmail( $this->mEmail ) ) {
                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 $this->getEditTimestamp( true );
    }

    public function getLatestEditTimestamp() {
        return $this->getEditTimestamp( false );
    }

    private function getEditTimestamp( $first ) {
        if ( $this->getId() == 0 ) {
            return false; // anons
        }
        $dbr = wfGetDB( DB_REPLICA );
        $actorWhere = ActorMigration::newMigration()->getWhere( $dbr, 'rev_user', $this );
        $tsField = isset( $actorWhere['tables']['temp_rev_user'] )
            ? 'revactor_timestamp' : 'rev_timestamp';
        $sortOrder = $first ? 'ASC' : 'DESC';
        $time = $dbr->selectField(
            [ 'revision' ] + $actorWhere['tables'],
            $tsField,
            [ $actorWhere['conds'] ],
            __METHOD__,
            [ 'ORDER BY' => "$tsField $sortOrder" ],
            $actorWhere['joins']
        );
        if ( !$time ) {
            return false; // no edits
        }
        return wfTimestamp( TS_MW, $time );
    }

    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 isEveryoneAllowed( $right ) {
        return MediaWikiServices::getInstance()->getPermissionManager()->isEveryoneAllowed( $right );
    }

    public static function getAllGroups() {
        global $wgGroupPermissions, $wgRevokePermissions;
        return array_values( array_diff(
            array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
            self::getImplicitGroups()
        ) );
    }

    public static function getAllRights() {
        return MediaWikiServices::getInstance()->getPermissionManager()->getAllPermissions();
    }

    public static function getImplicitGroups() {
        global $wgImplicitGroups;
        return $wgImplicitGroups;
    }

    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 ) {
        // Pull from a replica DB to be less cruel to servers
        // Accuracy isn't the point anyway here
        $actorWhere = ActorMigration::newMigration()->getWhere( $dbr, 'rev_user', $this );
        $count = (int)$dbr->selectField(
            [ 'revision' ] + $actorWhere['tables'],
            'COUNT(*)',
            [ $actorWhere['conds'] ],
            __METHOD__,
            [],
            $actorWhere['joins']
        );

        $dbw = wfGetDB( DB_MASTER );
        $dbw->update(
            'user',
            [ 'user_editcount' => $count ],
            [
                'user_id' => $this->getId(),
                'user_editcount IS NULL OR user_editcount < ' . (int)$count
            ],
            __METHOD__
        );

        return $count;
    }

    public static function getRightDescription( $right ) {
        $key = "right-$right";
        $msg = wfMessage( $key );
        return $msg->isDisabled() ? $right : $msg->text();
    }

    public static function getGrantName( $grant ) {
        $key = "grant-$grant";
        $msg = wfMessage( $key );
        return $msg->isDisabled() ? $grant : $msg->text();
    }

    public function addNewUserLogEntry( $action = false, $reason = '' ) {
        return true; // disabled
    }

    public function addNewUserLogEntryAutoCreate() {
        wfDeprecated( __METHOD__, '1.27' );
        $this->addNewUserLogEntry( 'autocreate' );

        return true;
    }

    protected function loadOptions( $data = null ) {
        $this->load();

        if ( $this->mOptionsLoaded ) {
            return;
        }

        $this->mOptions = self::getDefaultOptions();

        if ( !$this->getId() ) {
            // For unlogged-in users, load language/variant options from request.
            // There's no need to do it for logged-in users: they can set preferences,
            // and handling of page content is done by $pageLang->getPreferredVariant() and such,
            // so don't override user's choice (especially when the user chooses site default).
            $variant = MediaWikiServices::getInstance()->getContentLanguage()->getDefaultVariant();
            $this->mOptions['variant'] = $variant;
            $this->mOptions['language'] = $variant;
            $this->mOptionsLoaded = true;
            return;
        }

        // Maybe load from the object
        if ( !is_null( $this->mOptionOverrides ) ) {
            wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
            foreach ( $this->mOptionOverrides as $key => $value ) {
                $this->mOptions[$key] = $value;
            }
        } else {
            if ( !is_array( $data ) ) {
                wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
                // Load from database
                $dbr = ( $this->queryFlagsUsed & self::READ_LATEST )
                    ? wfGetDB( DB_MASTER )
                    : wfGetDB( DB_REPLICA );

                $res = $dbr->select(
                    'user_properties',
                    [ 'up_property', 'up_value' ],
                    [ 'up_user' => $this->getId() ],
                    __METHOD__
                );

                $this->mOptionOverrides = [];
                $data = [];
                foreach ( $res as $row ) {
                    // Convert '0' to 0. PHP's boolean conversion considers them both
                    // false, but e.g. JavaScript considers the former as true.
                    // @todo: T54542 Somehow determine the desired type (string/int/bool)
                    //  and convert all values here.
                    if ( $row->up_value === '0' ) {
                        $row->up_value = 0;
                    }
                    $data[$row->up_property] = $row->up_value;
                }
            }

            foreach ( $data as $property => $value ) {
                $this->mOptionOverrides[$property] = $value;
                $this->mOptions[$property] = $value;
            }
        }

        // Replace deprecated language codes
        $this->mOptions['language'] = LanguageCode::replaceDeprecatedCodes(
            $this->mOptions['language']
        );

        $this->mOptionsLoaded = true;

        Hooks::run( 'UserLoadOptions', [ $this, &$this->mOptions ] );
    }

    protected function saveOptions() {
        $this->loadOptions();

        // Not using getOptions(), to keep hidden preferences in database
        $saveOptions = $this->mOptions;

        // Allow hooks to abort, for instance to save to a global profile.
        // Reset options to default state before saving.
        if ( !Hooks::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
            return;
        }

        $userId = $this->getId();

        $insert_rows = []; // all the new preference rows
        foreach ( $saveOptions as $key => $value ) {
            // Don't bother storing default values
            $defaultOption = self::getDefaultOption( $key );
            if ( ( $defaultOption === null && $value !== false && $value !== null )
                || $value != $defaultOption
            ) {
                $insert_rows[] = [
                    'up_user' => $userId,
                    'up_property' => $key,
                    'up_value' => $value,
                ];
            }
        }

        $dbw = wfGetDB( DB_MASTER );

        $res = $dbw->select( 'user_properties',
            [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__ );

        // Find prior rows that need to be removed or updated. These rows will
        // all be deleted (the latter so that INSERT IGNORE applies the new values).
        $keysDelete = [];
        foreach ( $res as $row ) {
            if ( !isset( $saveOptions[$row->up_property] )
                || strcmp( $saveOptions[$row->up_property], $row->up_value ) != 0
            ) {
                $keysDelete[] = $row->up_property;
            }
        }

        if ( count( $keysDelete ) ) {
            // Do the DELETE by PRIMARY KEY for prior rows.
            // In the past a very large portion of calls to this function are for setting
            // 'rememberpassword' for new accounts (a preference that has since been removed).
            // Doing a blanket per-user DELETE for new accounts with no rows in the table
            // caused gap locks on [max user ID,+infinity) which caused high contention since
            // updates would pile up on each other as they are for higher (newer) user IDs.
            // It might not be necessary these days, but it shouldn't hurt either.
            $dbw->delete( 'user_properties',
                [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__ );
        }
        // Insert the new preference rows
        $dbw->insert( 'user_properties', $insert_rows, __METHOD__, [ 'IGNORE' ] );
    }

    public static function selectFields() {
        wfDeprecated( __METHOD__, '1.31' );
        return [
            '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',
        ];
    }

    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;
    }

    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 ) {
        // 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;
    }

}