3 * Implements the User class for the %MediaWiki software.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\Block\AbstractBlock
;
24 use MediaWiki\Block\DatabaseBlock
;
25 use MediaWiki\Block\SystemBlock
;
26 use MediaWiki\MediaWikiServices
;
27 use MediaWiki\Session\SessionManager
;
28 use MediaWiki\Session\Token
;
29 use MediaWiki\Auth\AuthManager
;
30 use MediaWiki\Auth\AuthenticationResponse
;
31 use MediaWiki\Auth\AuthenticationRequest
;
32 use MediaWiki\User\UserIdentity
;
33 use MediaWiki\Logger\LoggerFactory
;
34 use Wikimedia\Assert\Assert
;
36 use Wikimedia\ScopedCallback
;
37 use Wikimedia\Rdbms\Database
;
38 use Wikimedia\Rdbms\DBExpectedError
;
39 use Wikimedia\Rdbms\IDatabase
;
42 * The User object encapsulates all of the user-specific settings (user_id,
43 * name, rights, email address, options, last login time). Client
44 * classes use the getXXX() functions to access these fields. These functions
45 * do all the work of determining whether the user is logged in,
46 * whether the requested option can be satisfied from cookies or
47 * whether a database query is needed. Most of the settings needed
48 * for rendering normal pages are set in the cookie to minimize use
51 class User
implements IDBAccessObject
, UserIdentity
{
54 * Number of characters required for the user_token field.
56 const TOKEN_LENGTH
= 32;
59 * An invalid string value for the user_token field.
61 const INVALID_TOKEN
= '*** INVALID ***';
64 * Version number to tag cached versions of serialized User objects. Should be increased when
65 * {@link $mCacheVars} or one of it's members changes.
70 * Exclude user options that are set to their default value.
73 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
78 const CHECK_USER_RIGHTS
= true;
83 const IGNORE_USER_RIGHTS
= false;
86 * Array of Strings List of member variables which are saved to the
87 * shared cache (memcached). Any operation which changes the
88 * corresponding database fields must call a cache-clearing function.
92 protected static $mCacheVars = [
100 'mEmailAuthenticated',
102 'mEmailTokenExpires',
107 // user_properties table
114 * Array of Strings Core rights.
115 * Each of these should have a corresponding message of the form
120 protected static $mCoreRights = [
168 'move-categorypages',
169 'move-rootuserpages',
173 'override-export-depth',
195 'userrights-interwiki',
203 * @var string[] Cached results of getAllRights()
205 protected static $mAllRights = false;
207 /** Cache variables */
220 /** @var string TS_MW timestamp from the DB */
222 /** @var string TS_MW timestamp from cache */
223 protected $mQuickTouched;
227 public $mEmailAuthenticated;
229 protected $mEmailToken;
231 protected $mEmailTokenExpires;
233 protected $mRegistration;
235 protected $mEditCount;
236 /** @var UserGroupMembership[] Associative array of (group name => UserGroupMembership object) */
237 protected $mGroupMemberships;
239 protected $mOptionOverrides;
244 * @var bool Whether the cache variables have been loaded.
246 public $mOptionsLoaded;
249 * @var array|bool Array with already loaded items or true if all items have been loaded.
251 protected $mLoadedItems = [];
255 * @var string Initialization data source if mLoadedItems!==true. May be one of:
256 * - 'defaults' anonymous user initialised from class defaults
257 * - 'name' initialise from mName
258 * - 'id' initialise from mId
259 * - 'actor' initialise from mActorId
260 * - 'session' log in from session if possible
262 * Use the User::newFrom*() family of functions to set this.
267 * Lazy-initialized variables, invalidated with clearInstanceCache
272 protected $mDatePreference;
280 protected $mBlockreason;
282 protected $mEffectiveGroups;
284 protected $mImplicitGroups;
286 protected $mFormerGroups;
287 /** @var AbstractBlock */
288 protected $mGlobalBlock;
296 /** @var WebRequest */
299 /** @var AbstractBlock */
303 protected $mAllowUsertalk;
305 /** @var AbstractBlock|bool */
306 private $mBlockedFromCreateAccount = false;
308 /** @var int User::READ_* constant bitfield used to load data */
309 protected $queryFlagsUsed = self
::READ_NORMAL
;
312 public static $idCacheByName = [];
315 * Lightweight constructor for an anonymous user.
316 * Use the User::newFrom* factory functions for other kinds of users.
320 * @see newFromActorId()
321 * @see newFromConfirmationCode()
322 * @see newFromSession()
325 public function __construct() {
326 $this->clearInstanceCache( 'defaults' );
332 public function __toString() {
333 return (string)$this->getName();
337 * Test if it's safe to load this User object.
339 * You should typically check this before using $wgUser or
340 * RequestContext::getUser in a method that might be called before the
341 * system has been fully initialized. If the object is unsafe, you should
342 * use an anonymous user:
344 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
350 public function isSafeToLoad() {
351 global $wgFullyInitialised;
353 // The user is safe to load if:
354 // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
355 // * mLoadedItems === true (already loaded)
356 // * mFrom !== 'session' (sessions not involved at all)
358 return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
359 $this->mLoadedItems
=== true ||
$this->mFrom
!== 'session';
363 * Load the user table data for this object from the source given by mFrom.
365 * @param int $flags User::READ_* constant bitfield
367 public function load( $flags = self
::READ_NORMAL
) {
368 global $wgFullyInitialised;
370 if ( $this->mLoadedItems
=== true ) {
374 // Set it now to avoid infinite recursion in accessors
375 $oldLoadedItems = $this->mLoadedItems
;
376 $this->mLoadedItems
= true;
377 $this->queryFlagsUsed
= $flags;
379 // If this is called too early, things are likely to break.
380 if ( !$wgFullyInitialised && $this->mFrom
=== 'session' ) {
381 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
382 ->warning( 'User::loadFromSession called before the end of Setup.php', [
383 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
385 $this->loadDefaults();
386 $this->mLoadedItems
= $oldLoadedItems;
390 switch ( $this->mFrom
) {
392 $this->loadDefaults();
395 // Make sure this thread sees its own changes
396 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
397 if ( $lb->hasOrMadeRecentMasterChanges() ) {
398 $flags |
= self
::READ_LATEST
;
399 $this->queryFlagsUsed
= $flags;
402 $this->mId
= self
::idFromName( $this->mName
, $flags );
404 // Nonexistent user placeholder object
405 $this->loadDefaults( $this->mName
);
407 $this->loadFromId( $flags );
411 // Make sure this thread sees its own changes, if the ID isn't 0
412 if ( $this->mId
!= 0 ) {
413 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
414 if ( $lb->hasOrMadeRecentMasterChanges() ) {
415 $flags |
= self
::READ_LATEST
;
416 $this->queryFlagsUsed
= $flags;
420 $this->loadFromId( $flags );
423 // Make sure this thread sees its own changes
424 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
425 if ( $lb->hasOrMadeRecentMasterChanges() ) {
426 $flags |
= self
::READ_LATEST
;
427 $this->queryFlagsUsed
= $flags;
430 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
431 $row = wfGetDB( $index )->selectRow(
433 [ 'actor_user', 'actor_name' ],
434 [ 'actor_id' => $this->mActorId
],
441 $this->loadDefaults();
442 } elseif ( $row->actor_user
) {
443 $this->mId
= $row->actor_user
;
444 $this->loadFromId( $flags );
446 $this->loadDefaults( $row->actor_name
);
450 if ( !$this->loadFromSession() ) {
451 // Loading from session failed. Load defaults.
452 $this->loadDefaults();
454 Hooks
::run( 'UserLoadAfterLoadFromSession', [ $this ] );
457 throw new UnexpectedValueException(
458 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
463 * Load user table data, given mId has already been set.
464 * @param int $flags User::READ_* constant bitfield
465 * @return bool False if the ID does not exist, true otherwise
467 public function loadFromId( $flags = self
::READ_NORMAL
) {
468 if ( $this->mId
== 0 ) {
469 // Anonymous users are not in the database (don't need cache)
470 $this->loadDefaults();
474 // Try cache (unless this needs data from the master DB).
475 // NOTE: if this thread called saveSettings(), the cache was cleared.
476 $latest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
478 if ( !$this->loadFromDatabase( $flags ) ) {
479 // Can't load from ID
483 $this->loadFromCache();
486 $this->mLoadedItems
= true;
487 $this->queryFlagsUsed
= $flags;
494 * @param string $wikiId
497 public static function purge( $wikiId, $userId ) {
498 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
499 $key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
500 $cache->delete( $key );
505 * @param WANObjectCache $cache
508 protected function getCacheKey( WANObjectCache
$cache ) {
509 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
511 return $cache->makeGlobalKey( 'user', 'id', $lbFactory->getLocalDomainID(), $this->mId
);
515 * @param WANObjectCache $cache
519 public function getMutableCacheKeys( WANObjectCache
$cache ) {
520 $id = $this->getId();
522 return $id ?
[ $this->getCacheKey( $cache ) ] : [];
526 * Load user data from shared cache, given mId has already been set.
531 protected function loadFromCache() {
532 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
533 $data = $cache->getWithSetCallback(
534 $this->getCacheKey( $cache ),
536 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
537 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
538 wfDebug( "User: cache miss for user {$this->mId}\n" );
540 $this->loadFromDatabase( self
::READ_NORMAL
);
542 $this->loadOptions();
545 foreach ( self
::$mCacheVars as $name ) {
546 $data[$name] = $this->$name;
549 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->mTouched
), $ttl );
551 // if a user group membership is about to expire, the cache needs to
552 // expire at that time (T163691)
553 foreach ( $this->mGroupMemberships
as $ugm ) {
554 if ( $ugm->getExpiry() ) {
555 $secondsUntilExpiry = wfTimestamp( TS_UNIX
, $ugm->getExpiry() ) - time();
556 if ( $secondsUntilExpiry > 0 && $secondsUntilExpiry < $ttl ) {
557 $ttl = $secondsUntilExpiry;
564 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'version' => self
::VERSION
]
567 // Restore from cache
568 foreach ( self
::$mCacheVars as $name ) {
569 $this->$name = $data[$name];
575 /** @name newFrom*() static factory methods */
579 * Static factory method for creation from username.
581 * This is slightly less efficient than newFromId(), so use newFromId() if
582 * you have both an ID and a name handy.
584 * @param string $name Username, validated by Title::newFromText()
585 * @param string|bool $validate Validate username. Takes the same parameters as
586 * User::getCanonicalName(), except that true is accepted as an alias
587 * for 'valid', for BC.
589 * @return User|bool User object, or false if the username is invalid
590 * (e.g. if it contains illegal characters or is an IP address). If the
591 * username is not present in the database, the result will be a user object
592 * with a name, zero user ID and default settings.
594 public static function newFromName( $name, $validate = 'valid' ) {
595 if ( $validate === true ) {
598 $name = self
::getCanonicalName( $name, $validate );
599 if ( $name === false ) {
603 // Create unloaded user object
607 $u->setItemLoaded( 'name' );
613 * Static factory method for creation from a given user ID.
615 * @param int $id Valid user ID
616 * @return User The corresponding User object
618 public static function newFromId( $id ) {
622 $u->setItemLoaded( 'id' );
627 * Static factory method for creation from a given actor ID.
630 * @param int $id Valid actor ID
631 * @return User The corresponding User object
633 public static function newFromActorId( $id ) {
634 global $wgActorTableSchemaMigrationStage;
636 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
637 // but it does little harm and might be needed for write callers loading a User.
638 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) ) {
639 throw new BadMethodCallException(
640 'Cannot use ' . __METHOD__
641 . ' when $wgActorTableSchemaMigrationStage lacks SCHEMA_COMPAT_NEW'
648 $u->setItemLoaded( 'actor' );
653 * Returns a User object corresponding to the given UserIdentity.
657 * @param UserIdentity $identity
661 public static function newFromIdentity( UserIdentity
$identity ) {
662 if ( $identity instanceof User
) {
666 return self
::newFromAnyId(
667 $identity->getId() === 0 ?
null : $identity->getId(),
668 $identity->getName() === '' ?
null : $identity->getName(),
669 $identity->getActorId() === 0 ?
null : $identity->getActorId()
674 * Static factory method for creation from an ID, name, and/or actor ID
676 * This does not check that the ID, name, and actor ID all correspond to
680 * @param int|null $userId User ID, if known
681 * @param string|null $userName User name, if known
682 * @param int|null $actorId Actor ID, if known
683 * @param bool|string $wikiId remote wiki to which the User/Actor ID applies, or false if none
686 public static function newFromAnyId( $userId, $userName, $actorId, $wikiId = false ) {
687 global $wgActorTableSchemaMigrationStage;
689 // Stop-gap solution for the problem described in T222212.
690 // Force the User ID and Actor ID to zero for users loaded from the database
691 // of another wiki, to prevent subtle data corruption and confusing failure modes.
692 if ( $wikiId !== false ) {
698 $user->mFrom
= 'defaults';
700 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
701 // but it does little harm and might be needed for write callers loading a User.
702 if ( ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) && $actorId !== null ) {
703 $user->mActorId
= (int)$actorId;
704 if ( $user->mActorId
!== 0 ) {
705 $user->mFrom
= 'actor';
707 $user->setItemLoaded( 'actor' );
710 if ( $userName !== null && $userName !== '' ) {
711 $user->mName
= $userName;
712 $user->mFrom
= 'name';
713 $user->setItemLoaded( 'name' );
716 if ( $userId !== null ) {
717 $user->mId
= (int)$userId;
718 if ( $user->mId
!== 0 ) {
721 $user->setItemLoaded( 'id' );
724 if ( $user->mFrom
=== 'defaults' ) {
725 throw new InvalidArgumentException(
726 'Cannot create a user with no name, no ID, and no actor ID'
734 * Factory method to fetch whichever user has a given email confirmation code.
735 * This code is generated when an account is created or its e-mail address
738 * If the code is invalid or has expired, returns NULL.
740 * @param string $code Confirmation code
741 * @param int $flags User::READ_* bitfield
744 public static function newFromConfirmationCode( $code, $flags = 0 ) {
745 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
746 ?
wfGetDB( DB_MASTER
)
747 : wfGetDB( DB_REPLICA
);
749 $id = $db->selectField(
753 'user_email_token' => md5( $code ),
754 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
758 return $id ? self
::newFromId( $id ) : null;
762 * Create a new user object using data from session. If the login
763 * credentials are invalid, the result is an anonymous user.
765 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
768 public static function newFromSession( WebRequest
$request = null ) {
770 $user->mFrom
= 'session';
771 $user->mRequest
= $request;
776 * Create a new user object from a user row.
777 * The row should have the following fields from the user table in it:
778 * - either user_name or user_id to load further data if needed (or both)
780 * - all other fields (email, etc.)
781 * It is useless to provide the remaining fields if either user_id,
782 * user_name and user_real_name are not provided because the whole row
783 * will be loaded once more from the database when accessing them.
785 * @param stdClass $row A row from the user table
786 * @param array|null $data Further data to load into the object
787 * (see User::loadFromRow for valid keys)
790 public static function newFromRow( $row, $data = null ) {
792 $user->loadFromRow( $row, $data );
797 * Static factory method for creation of a "system" user from username.
799 * A "system" user is an account that's used to attribute logged actions
800 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
801 * might include the 'Maintenance script' or 'Conversion script' accounts
802 * used by various scripts in the maintenance/ directory or accounts such
803 * as 'MediaWiki message delivery' used by the MassMessage extension.
805 * This can optionally create the user if it doesn't exist, and "steal" the
806 * account if it does exist.
808 * "Stealing" an existing user is intended to make it impossible for normal
809 * authentication processes to use the account, effectively disabling the
810 * account for normal use:
811 * - Email is invalidated, to prevent account recovery by emailing a
812 * temporary password and to disassociate the account from the existing
814 * - The token is set to a magic invalid value, to kill existing sessions
815 * and to prevent $this->setToken() calls from resetting the token to a
817 * - SessionManager is instructed to prevent new sessions for the user, to
818 * do things like deauthorizing OAuth consumers.
819 * - AuthManager is instructed to revoke access, to invalidate or remove
820 * passwords and other credentials.
822 * @param string $name Username
823 * @param array $options Options are:
824 * - validate: As for User::getCanonicalName(), default 'valid'
825 * - create: Whether to create the user if it doesn't already exist, default true
826 * - steal: Whether to "disable" the account for normal use if it already
827 * exists, default false
831 public static function newSystemUser( $name, $options = [] ) {
833 'validate' => 'valid',
838 $name = self
::getCanonicalName( $name, $options['validate'] );
839 if ( $name === false ) {
843 $dbr = wfGetDB( DB_REPLICA
);
844 $userQuery = self
::getQueryInfo();
845 $row = $dbr->selectRow(
846 $userQuery['tables'],
847 $userQuery['fields'],
848 [ 'user_name' => $name ],
854 // Try the master database...
855 $dbw = wfGetDB( DB_MASTER
);
856 $row = $dbw->selectRow(
857 $userQuery['tables'],
858 $userQuery['fields'],
859 [ 'user_name' => $name ],
867 // No user. Create it?
868 return $options['create']
869 ? self
::createNew( $name, [ 'token' => self
::INVALID_TOKEN
] )
873 $user = self
::newFromRow( $row );
875 // A user is considered to exist as a non-system user if it can
876 // authenticate, or has an email set, or has a non-invalid token.
877 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
878 AuthManager
::singleton()->userCanAuthenticate( $name )
880 // User exists. Steal it?
881 if ( !$options['steal'] ) {
885 AuthManager
::singleton()->revokeAccessForUser( $name );
887 $user->invalidateEmail();
888 $user->mToken
= self
::INVALID_TOKEN
;
889 $user->saveSettings();
890 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
899 * Get the username corresponding to a given user ID
900 * @param int $id User ID
901 * @return string|bool The corresponding username
903 public static function whoIs( $id ) {
904 return UserCache
::singleton()->getProp( $id, 'name' );
908 * Get the real name of a user given their user ID
910 * @param int $id User ID
911 * @return string|bool The corresponding user's real name
913 public static function whoIsReal( $id ) {
914 return UserCache
::singleton()->getProp( $id, 'real_name' );
918 * Get database id given a user name
919 * @param string $name Username
920 * @param int $flags User::READ_* constant bitfield
921 * @return int|null The corresponding user's ID, or null if user is nonexistent
923 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
924 // Don't explode on self::$idCacheByName[$name] if $name is not a string but e.g. a User object
925 $name = (string)$name;
926 $nt = Title
::makeTitleSafe( NS_USER
, $name );
927 if ( is_null( $nt ) ) {
932 if ( !( $flags & self
::READ_LATEST
) && array_key_exists( $name, self
::$idCacheByName ) ) {
933 return is_null( self
::$idCacheByName[$name] ) ?
null : (int)self
::$idCacheByName[$name];
936 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
937 $db = wfGetDB( $index );
942 [ 'user_name' => $nt->getText() ],
947 if ( $s === false ) {
950 $result = (int)$s->user_id
;
953 if ( count( self
::$idCacheByName ) >= 1000 ) {
954 self
::$idCacheByName = [];
957 self
::$idCacheByName[$name] = $result;
963 * Reset the cache used in idFromName(). For use in tests.
965 public static function resetIdByNameCache() {
966 self
::$idCacheByName = [];
970 * Does the string match an anonymous IP address?
972 * This function exists for username validation, in order to reject
973 * usernames which are similar in form to IP addresses. Strings such
974 * as 300.300.300.300 will return true because it looks like an IP
975 * address, despite not being strictly valid.
977 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
978 * address because the usemod software would "cloak" anonymous IP
979 * addresses like this, if we allowed accounts like this to be created
980 * new users could get the old edits of these anonymous users.
982 * @param string $name Name to match
985 public static function isIP( $name ) {
986 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
987 || IP
::isIPv6( $name );
991 * Is the user an IP range?
996 public function isIPRange() {
997 return IP
::isValidRange( $this->mName
);
1001 * Is the input a valid username?
1003 * Checks if the input is a valid username, we don't want an empty string,
1004 * an IP address, anything that contains slashes (would mess up subpages),
1005 * is longer than the maximum allowed username size or doesn't begin with
1008 * @param string $name Name to match
1011 public static function isValidUserName( $name ) {
1012 global $wgMaxNameChars;
1015 || self
::isIP( $name )
1016 ||
strpos( $name, '/' ) !== false
1017 ||
strlen( $name ) > $wgMaxNameChars
1018 ||
$name != MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name )
1023 // Ensure that the name can't be misresolved as a different title,
1024 // such as with extra namespace keys at the start.
1025 $parsed = Title
::newFromText( $name );
1026 if ( is_null( $parsed )
1027 ||
$parsed->getNamespace()
1028 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
1032 // Check an additional blacklist of troublemaker characters.
1033 // Should these be merged into the title char list?
1034 $unicodeBlacklist = '/[' .
1035 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
1036 '\x{00a0}' . # non-breaking space
1037 '\x{2000}-\x{200f}' . # various whitespace
1038 '\x{2028}-\x{202f}' . # breaks and control chars
1039 '\x{3000}' . # ideographic space
1040 '\x{e000}-\x{f8ff}' . # private use
1042 if ( preg_match( $unicodeBlacklist, $name ) ) {
1050 * Usernames which fail to pass this function will be blocked
1051 * from user login and new account registrations, but may be used
1052 * internally by batch processes.
1054 * If an account already exists in this form, login will be blocked
1055 * by a failure to pass this function.
1057 * @param string $name Name to match
1060 public static function isUsableName( $name ) {
1061 global $wgReservedUsernames;
1062 // Must be a valid username, obviously ;)
1063 if ( !self
::isValidUserName( $name ) ) {
1067 static $reservedUsernames = false;
1068 if ( !$reservedUsernames ) {
1069 $reservedUsernames = $wgReservedUsernames;
1070 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
1073 // Certain names may be reserved for batch processes.
1074 foreach ( $reservedUsernames as $reserved ) {
1075 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
1076 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->plain();
1078 if ( $reserved == $name ) {
1086 * Return the users who are members of the given group(s). In case of multiple groups,
1087 * users who are members of at least one of them are returned.
1089 * @param string|array $groups A single group name or an array of group names
1090 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
1091 * records; larger values are ignored.
1092 * @param int|null $after ID the user to start after
1093 * @return UserArrayFromResult
1095 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
1096 if ( $groups === [] ) {
1097 return UserArrayFromResult
::newFromIDs( [] );
1100 $groups = array_unique( (array)$groups );
1101 $limit = min( 5000, $limit );
1103 $conds = [ 'ug_group' => $groups ];
1104 if ( $after !== null ) {
1105 $conds[] = 'ug_user > ' . (int)$after;
1108 $dbr = wfGetDB( DB_REPLICA
);
1109 $ids = $dbr->selectFieldValues(
1116 'ORDER BY' => 'ug_user',
1120 return UserArray
::newFromIDs( $ids );
1124 * Usernames which fail to pass this function will be blocked
1125 * from new account registrations, but may be used internally
1126 * either by batch processes or by user accounts which have
1127 * already been created.
1129 * Additional blacklisting may be added here rather than in
1130 * isValidUserName() to avoid disrupting existing accounts.
1132 * @param string $name String to match
1135 public static function isCreatableName( $name ) {
1136 global $wgInvalidUsernameCharacters;
1138 // Ensure that the username isn't longer than 235 bytes, so that
1139 // (at least for the builtin skins) user javascript and css files
1140 // will work. (T25080)
1141 if ( strlen( $name ) > 235 ) {
1142 wfDebugLog( 'username', __METHOD__
.
1143 ": '$name' invalid due to length" );
1147 // Preg yells if you try to give it an empty string
1148 if ( $wgInvalidUsernameCharacters !== '' &&
1149 preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name )
1151 wfDebugLog( 'username', __METHOD__
.
1152 ": '$name' invalid due to wgInvalidUsernameCharacters" );
1156 return self
::isUsableName( $name );
1160 * Is the input a valid password for this user?
1162 * @param string $password Desired password
1165 public function isValidPassword( $password ) {
1166 // simple boolean wrapper for checkPasswordValidity
1167 return $this->checkPasswordValidity( $password )->isGood();
1171 * Check if this is a valid password for this user
1173 * Returns a Status object with a set of messages describing
1174 * problems with the password. If the return status is fatal,
1175 * the action should be refused and the password should not be
1176 * checked at all (this is mainly meant for DoS mitigation).
1177 * If the return value is OK but not good, the password can be checked,
1178 * but the user should not be able to set their password to this.
1179 * The value of the returned Status object will be an array which
1180 * can have the following fields:
1181 * - forceChange (bool): if set to true, the user should not be
1182 * allowed to log with this password unless they change it during
1183 * the login process (see ResetPasswordSecondaryAuthenticationProvider).
1184 * - suggestChangeOnLogin (bool): if set to true, the user should be prompted for
1185 * a password change on login.
1187 * @param string $password Desired password
1191 public function checkPasswordValidity( $password ) {
1192 global $wgPasswordPolicy;
1194 $upp = new UserPasswordPolicy(
1195 $wgPasswordPolicy['policies'],
1196 $wgPasswordPolicy['checks']
1199 $status = Status
::newGood( [] );
1200 $result = false; // init $result to false for the internal checks
1202 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1203 $status->error( $result );
1207 if ( $result === false ) {
1208 $status->merge( $upp->checkUserPassword( $this, $password ), true );
1212 if ( $result === true ) {
1216 $status->error( $result );
1217 return $status; // the isValidPassword hook set a string $result and returned true
1221 * Given unvalidated user input, return a canonical username, or false if
1222 * the username is invalid.
1223 * @param string $name User input
1224 * @param string|bool $validate Type of validation to use:
1225 * - false No validation
1226 * - 'valid' Valid for batch processes
1227 * - 'usable' Valid for batch processes and login
1228 * - 'creatable' Valid for batch processes, login and account creation
1230 * @throws InvalidArgumentException
1231 * @return bool|string
1233 public static function getCanonicalName( $name, $validate = 'valid' ) {
1234 // Force usernames to capital
1235 $name = MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name );
1237 # Reject names containing '#'; these will be cleaned up
1238 # with title normalisation, but then it's too late to
1240 if ( strpos( $name, '#' ) !== false ) {
1244 // Clean up name according to title rules,
1245 // but only when validation is requested (T14654)
1246 $t = ( $validate !== false ) ?
1247 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1248 // Check for invalid titles
1249 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1253 $name = $t->getText();
1255 switch ( $validate ) {
1259 if ( !self
::isValidUserName( $name ) ) {
1264 if ( !self
::isUsableName( $name ) ) {
1269 if ( !self
::isCreatableName( $name ) ) {
1274 throw new InvalidArgumentException(
1275 'Invalid parameter value for $validate in ' . __METHOD__
);
1281 * Set cached properties to default.
1283 * @note This no longer clears uncached lazy-initialised properties;
1284 * the constructor does that instead.
1286 * @param string|bool $name
1288 public function loadDefaults( $name = false ) {
1290 $this->mName
= $name;
1291 $this->mActorId
= null;
1292 $this->mRealName
= '';
1294 $this->mOptionOverrides
= null;
1295 $this->mOptionsLoaded
= false;
1297 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1298 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1299 if ( $loggedOut !== 0 ) {
1300 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1302 $this->mTouched
= '1'; # Allow any pages to be cached
1305 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1306 $this->mEmailAuthenticated
= null;
1307 $this->mEmailToken
= '';
1308 $this->mEmailTokenExpires
= null;
1309 $this->mRegistration
= wfTimestamp( TS_MW
);
1310 $this->mGroupMemberships
= [];
1312 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1316 * Return whether an item has been loaded.
1318 * @param string $item Item to check. Current possibilities:
1322 * @param string $all 'all' to check if the whole object has been loaded
1323 * or any other string to check if only the item is available (e.g.
1327 public function isItemLoaded( $item, $all = 'all' ) {
1328 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1329 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1333 * Set that an item has been loaded
1335 * @param string $item
1337 protected function setItemLoaded( $item ) {
1338 if ( is_array( $this->mLoadedItems
) ) {
1339 $this->mLoadedItems
[$item] = true;
1344 * Load user data from the session.
1346 * @return bool True if the user is logged in, false otherwise.
1348 private function loadFromSession() {
1349 // MediaWiki\Session\Session already did the necessary authentication of the user
1350 // returned here, so just use it if applicable.
1351 $session = $this->getRequest()->getSession();
1352 $user = $session->getUser();
1353 if ( $user->isLoggedIn() ) {
1354 $this->loadFromUserObject( $user );
1355 if ( $user->getBlock() ) {
1356 // If this user is autoblocked, set a cookie to track the block. This has to be done on
1357 // every session load, because an autoblocked editor might not edit again from the same
1358 // IP address after being blocked.
1359 MediaWikiServices
::getInstance()->getBlockManager()->trackBlockWithCookie( $this );
1362 // Other code expects these to be set in the session, so set them.
1363 $session->set( 'wsUserID', $this->getId() );
1364 $session->set( 'wsUserName', $this->getName() );
1365 $session->set( 'wsToken', $this->getToken() );
1374 * Set the 'BlockID' cookie depending on block type and user authentication status.
1376 * @deprecated since 1.34 Use BlockManager::trackBlockWithCookie instead
1378 public function trackBlockWithCookie() {
1379 MediaWikiServices
::getInstance()->getBlockManager()->trackBlockWithCookie( $this );
1383 * Load user and user_group data from the database.
1384 * $this->mId must be set, this is how the user is identified.
1386 * @param int $flags User::READ_* constant bitfield
1387 * @return bool True if the user exists, false if the user is anonymous
1389 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1391 $this->mId
= intval( $this->mId
);
1393 if ( !$this->mId
) {
1394 // Anonymous users are not in the database
1395 $this->loadDefaults();
1399 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1400 $db = wfGetDB( $index );
1402 $userQuery = self
::getQueryInfo();
1403 $s = $db->selectRow(
1404 $userQuery['tables'],
1405 $userQuery['fields'],
1406 [ 'user_id' => $this->mId
],
1412 $this->queryFlagsUsed
= $flags;
1413 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1415 if ( $s !== false ) {
1416 // Initialise user table data
1417 $this->loadFromRow( $s );
1418 $this->mGroupMemberships
= null; // deferred
1419 $this->getEditCount(); // revalidation for nulls
1425 $this->loadDefaults();
1431 * Initialize this object from a row from the user table.
1433 * @param stdClass $row Row from the user table to load.
1434 * @param array|null $data Further user data to load into the object
1436 * user_groups Array of arrays or stdClass result rows out of the user_groups
1437 * table. Previously you were supposed to pass an array of strings
1438 * here, but we also need expiry info nowadays, so an array of
1439 * strings is ignored.
1440 * user_properties Array with properties out of the user_properties table
1442 protected function loadFromRow( $row, $data = null ) {
1443 global $wgActorTableSchemaMigrationStage;
1445 if ( !is_object( $row ) ) {
1446 throw new InvalidArgumentException( '$row must be an object' );
1451 $this->mGroupMemberships
= null; // deferred
1453 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
1454 // but it does little harm and might be needed for write callers loading a User.
1455 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
1456 if ( isset( $row->actor_id
) ) {
1457 $this->mActorId
= (int)$row->actor_id
;
1458 if ( $this->mActorId
!== 0 ) {
1459 $this->mFrom
= 'actor';
1461 $this->setItemLoaded( 'actor' );
1467 if ( isset( $row->user_name
) && $row->user_name
!== '' ) {
1468 $this->mName
= $row->user_name
;
1469 $this->mFrom
= 'name';
1470 $this->setItemLoaded( 'name' );
1475 if ( isset( $row->user_real_name
) ) {
1476 $this->mRealName
= $row->user_real_name
;
1477 $this->setItemLoaded( 'realname' );
1482 if ( isset( $row->user_id
) ) {
1483 $this->mId
= intval( $row->user_id
);
1484 if ( $this->mId
!== 0 ) {
1485 $this->mFrom
= 'id';
1487 $this->setItemLoaded( 'id' );
1492 if ( isset( $row->user_id
) && isset( $row->user_name
) && $row->user_name
!== '' ) {
1493 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1496 if ( isset( $row->user_editcount
) ) {
1497 $this->mEditCount
= $row->user_editcount
;
1502 if ( isset( $row->user_touched
) ) {
1503 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1508 if ( isset( $row->user_token
) ) {
1509 // The definition for the column is binary(32), so trim the NULs
1510 // that appends. The previous definition was char(32), so trim
1512 $this->mToken
= rtrim( $row->user_token
, " \0" );
1513 if ( $this->mToken
=== '' ) {
1514 $this->mToken
= null;
1520 if ( isset( $row->user_email
) ) {
1521 $this->mEmail
= $row->user_email
;
1522 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1523 $this->mEmailToken
= $row->user_email_token
;
1524 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1525 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1531 $this->mLoadedItems
= true;
1534 if ( is_array( $data ) ) {
1535 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1536 if ( $data['user_groups'] === [] ) {
1537 $this->mGroupMemberships
= [];
1539 $firstGroup = reset( $data['user_groups'] );
1540 if ( is_array( $firstGroup ) ||
is_object( $firstGroup ) ) {
1541 $this->mGroupMemberships
= [];
1542 foreach ( $data['user_groups'] as $row ) {
1543 $ugm = UserGroupMembership
::newFromRow( (object)$row );
1544 $this->mGroupMemberships
[$ugm->getGroup()] = $ugm;
1549 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1550 $this->loadOptions( $data['user_properties'] );
1556 * Load the data for this user object from another user object.
1560 protected function loadFromUserObject( $user ) {
1562 foreach ( self
::$mCacheVars as $var ) {
1563 $this->$var = $user->$var;
1568 * Load the groups from the database if they aren't already loaded.
1570 private function loadGroups() {
1571 if ( is_null( $this->mGroupMemberships
) ) {
1572 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1573 ?
wfGetDB( DB_MASTER
)
1574 : wfGetDB( DB_REPLICA
);
1575 $this->mGroupMemberships
= UserGroupMembership
::getMembershipsForUser(
1581 * Add the user to the group if he/she meets given criteria.
1583 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1584 * possible to remove manually via Special:UserRights. In such case it
1585 * will not be re-added automatically. The user will also not lose the
1586 * group if they no longer meet the criteria.
1588 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1590 * @return array Array of groups the user has been promoted to.
1592 * @see $wgAutopromoteOnce
1594 public function addAutopromoteOnceGroups( $event ) {
1595 global $wgAutopromoteOnceLogInRC;
1597 if ( wfReadOnly() ||
!$this->getId() ) {
1601 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1602 if ( $toPromote === [] ) {
1606 if ( !$this->checkAndSetTouched() ) {
1607 return []; // raced out (bug T48834)
1610 $oldGroups = $this->getGroups(); // previous groups
1611 $oldUGMs = $this->getGroupMemberships();
1612 foreach ( $toPromote as $group ) {
1613 $this->addGroup( $group );
1615 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1616 $newUGMs = $this->getGroupMemberships();
1618 // update groups in external authentication database
1619 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );
1621 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1622 $logEntry->setPerformer( $this );
1623 $logEntry->setTarget( $this->getUserPage() );
1624 $logEntry->setParameters( [
1625 '4::oldgroups' => $oldGroups,
1626 '5::newgroups' => $newGroups,
1628 $logid = $logEntry->insert();
1629 if ( $wgAutopromoteOnceLogInRC ) {
1630 $logEntry->publish( $logid );
1637 * Builds update conditions. Additional conditions may be added to $conditions to
1638 * protected against race conditions using a compare-and-set (CAS) mechanism
1639 * based on comparing $this->mTouched with the user_touched field.
1641 * @param IDatabase $db
1642 * @param array $conditions WHERE conditions for use with Database::update
1643 * @return array WHERE conditions for use with Database::update
1645 protected function makeUpdateConditions( IDatabase
$db, array $conditions ) {
1646 if ( $this->mTouched
) {
1647 // CAS check: only update if the row wasn't changed sicne it was loaded.
1648 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1655 * Bump user_touched if it didn't change since this object was loaded
1657 * On success, the mTouched field is updated.
1658 * The user serialization cache is always cleared.
1660 * @return bool Whether user_touched was actually updated
1663 protected function checkAndSetTouched() {
1666 if ( !$this->mId
) {
1667 return false; // anon
1670 // Get a new user_touched that is higher than the old one
1671 $newTouched = $this->newTouchedTimestamp();
1673 $dbw = wfGetDB( DB_MASTER
);
1674 $dbw->update( 'user',
1675 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1676 $this->makeUpdateConditions( $dbw, [
1677 'user_id' => $this->mId
,
1681 $success = ( $dbw->affectedRows() > 0 );
1684 $this->mTouched
= $newTouched;
1685 $this->clearSharedCache( 'changed' );
1687 // Clears on failure too since that is desired if the cache is stale
1688 $this->clearSharedCache( 'refresh' );
1695 * Clear various cached data stored in this object. The cache of the user table
1696 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1698 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1699 * given source. May be "name", "id", "actor", "defaults", "session", or false for no reload.
1701 public function clearInstanceCache( $reloadFrom = false ) {
1702 $this->mNewtalk
= -1;
1703 $this->mDatePreference
= null;
1704 $this->mBlockedby
= -1; # Unset
1705 $this->mHash
= false;
1706 $this->mRights
= null;
1707 $this->mEffectiveGroups
= null;
1708 $this->mImplicitGroups
= null;
1709 $this->mGroupMemberships
= null;
1710 $this->mOptions
= null;
1711 $this->mOptionsLoaded
= false;
1712 $this->mEditCount
= null;
1714 if ( $reloadFrom ) {
1715 $this->mLoadedItems
= [];
1716 $this->mFrom
= $reloadFrom;
1720 /** @var array|null */
1721 private static $defOpt = null;
1722 /** @var string|null */
1723 private static $defOptLang = null;
1726 * Reset the process cache of default user options. This is only necessary
1727 * if the wiki configuration has changed since defaults were calculated,
1728 * and as such should only be performed inside the testing suite that
1729 * regularly changes wiki configuration.
1731 public static function resetGetDefaultOptionsForTestsOnly() {
1732 Assert
::invariant( defined( 'MW_PHPUNIT_TEST' ), 'Unit tests only' );
1733 self
::$defOpt = null;
1734 self
::$defOptLang = null;
1738 * Combine the language default options with any site-specific options
1739 * and add the default language variants.
1741 * @return array Array of String options
1743 public static function getDefaultOptions() {
1744 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgDefaultSkin;
1746 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
1747 if ( self
::$defOpt !== null && self
::$defOptLang === $contLang->getCode() ) {
1748 // The content language does not change (and should not change) mid-request, but the
1749 // unit tests change it anyway, and expect this method to return values relevant to the
1750 // current content language.
1751 return self
::$defOpt;
1754 self
::$defOpt = $wgDefaultUserOptions;
1755 // Default language setting
1756 self
::$defOptLang = $contLang->getCode();
1757 self
::$defOpt['language'] = self
::$defOptLang;
1758 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1759 if ( $langCode === $contLang->getCode() ) {
1760 self
::$defOpt['variant'] = $langCode;
1762 self
::$defOpt["variant-$langCode"] = $langCode;
1766 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1767 // since extensions may change the set of searchable namespaces depending
1768 // on user groups/permissions.
1769 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1770 self
::$defOpt['searchNs' . $nsnum] = (bool)$val;
1772 self
::$defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1774 Hooks
::run( 'UserGetDefaultOptions', [ &self
::$defOpt ] );
1776 return self
::$defOpt;
1780 * Get a given default option value.
1782 * @param string $opt Name of option to retrieve
1783 * @return string Default option value
1785 public static function getDefaultOption( $opt ) {
1786 $defOpts = self
::getDefaultOptions();
1787 return $defOpts[$opt] ??
null;
1791 * Get blocking information
1793 * TODO: Move this into the BlockManager, along with block-related properties.
1795 * @param bool $fromReplica Whether to check the replica DB first.
1796 * To improve performance, non-critical checks are done against replica DBs.
1797 * Check when actually saving should be done against master.
1799 private function getBlockedStatus( $fromReplica = true ) {
1800 if ( $this->mBlockedby
!= -1 ) {
1804 wfDebug( __METHOD__
. ": checking...\n" );
1806 // Initialize data...
1807 // Otherwise something ends up stomping on $this->mBlockedby when
1808 // things get lazy-loaded later, causing false positive block hits
1809 // due to -1 !== 0. Probably session-related... Nothing should be
1810 // overwriting mBlockedby, surely?
1813 $block = MediaWikiServices
::getInstance()->getBlockManager()->getUserBlock(
1819 $this->mBlock
= $block;
1820 $this->mBlockedby
= $block->getByName();
1821 $this->mBlockreason
= $block->getReason();
1822 $this->mHideName
= $block->getHideName();
1823 $this->mAllowUsertalk
= $block->isUsertalkEditAllowed();
1825 $this->mBlock
= null;
1826 $this->mBlockedby
= '';
1827 $this->mBlockreason
= '';
1828 $this->mHideName
= 0;
1829 $this->mAllowUsertalk
= false;
1832 // Avoid PHP 7.1 warning of passing $this by reference
1835 Hooks
::run( 'GetBlockedStatus', [ &$thisUser ] );
1839 * Whether the given IP is in a DNS blacklist.
1841 * @deprecated since 1.34 Use BlockManager::isDnsBlacklisted.
1842 * @param string $ip IP to check
1843 * @param bool $checkWhitelist Whether to check the whitelist first
1844 * @return bool True if blacklisted.
1846 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1847 return MediaWikiServices
::getInstance()->getBlockManager()
1848 ->isDnsBlacklisted( $ip, $checkWhitelist );
1852 * Whether the given IP is in a given DNS blacklist.
1854 * @deprecated since 1.34 Check via BlockManager::isDnsBlacklisted instead.
1855 * @param string $ip IP to check
1856 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1857 * @return bool True if blacklisted.
1859 public function inDnsBlacklist( $ip, $bases ) {
1860 wfDeprecated( __METHOD__
, '1.34' );
1863 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
1864 if ( IP
::isIPv4( $ip ) ) {
1865 // Reverse IP, T23255
1866 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1868 foreach ( (array)$bases as $base ) {
1870 // If we have an access key, use that too (ProjectHoneypot, etc.)
1872 if ( is_array( $base ) ) {
1873 if ( count( $base ) >= 2 ) {
1874 // Access key is 1, base URL is 0
1875 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1877 $host = "$ipReversed.{$base[0]}";
1879 $basename = $base[0];
1881 $host = "$ipReversed.$base";
1885 $ipList = gethostbynamel( $host );
1888 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
1893 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
1901 * Check if an IP address is in the local proxy list
1903 * @deprecated since 1.34 Use BlockManager::getUserBlock instead.
1907 public static function isLocallyBlockedProxy( $ip ) {
1908 wfDeprecated( __METHOD__
, '1.34' );
1910 global $wgProxyList;
1912 if ( !$wgProxyList ) {
1916 if ( !is_array( $wgProxyList ) ) {
1917 // Load values from the specified file
1918 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1921 $resultProxyList = [];
1922 $deprecatedIPEntries = [];
1924 // backward compatibility: move all ip addresses in keys to values
1925 foreach ( $wgProxyList as $key => $value ) {
1926 $keyIsIP = IP
::isIPAddress( $key );
1927 $valueIsIP = IP
::isIPAddress( $value );
1928 if ( $keyIsIP && !$valueIsIP ) {
1929 $deprecatedIPEntries[] = $key;
1930 $resultProxyList[] = $key;
1931 } elseif ( $keyIsIP && $valueIsIP ) {
1932 $deprecatedIPEntries[] = $key;
1933 $resultProxyList[] = $key;
1934 $resultProxyList[] = $value;
1936 $resultProxyList[] = $value;
1940 if ( $deprecatedIPEntries ) {
1942 'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
1943 implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
1946 $proxyListIPSet = new IPSet( $resultProxyList );
1947 return $proxyListIPSet->match( $ip );
1951 * Is this user subject to rate limiting?
1953 * @return bool True if rate limited
1955 public function isPingLimitable() {
1956 global $wgRateLimitsExcludedIPs;
1957 if ( IP
::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1958 // No other good way currently to disable rate limits
1959 // for specific IPs. :P
1960 // But this is a crappy hack and should die.
1963 return !$this->isAllowed( 'noratelimit' );
1967 * Primitive rate limits: enforce maximum actions per time period
1968 * to put a brake on flooding.
1970 * The method generates both a generic profiling point and a per action one
1971 * (suffix being "-$action".
1973 * @note When using a shared cache like memcached, IP-address
1974 * last-hit counters will be shared across wikis.
1976 * @param string $action Action to enforce; 'edit' if unspecified
1977 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1978 * @return bool True if a rate limiter was tripped
1980 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1981 // Avoid PHP 7.1 warning of passing $this by reference
1983 // Call the 'PingLimiter' hook
1985 if ( !Hooks
::run( 'PingLimiter', [ &$user, $action, &$result, $incrBy ] ) ) {
1989 global $wgRateLimits;
1990 if ( !isset( $wgRateLimits[$action] ) ) {
1994 $limits = array_merge(
1995 [ '&can-bypass' => true ],
1996 $wgRateLimits[$action]
1999 // Some groups shouldn't trigger the ping limiter, ever
2000 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
2005 $id = $this->getId();
2007 $isNewbie = $this->isNewbie();
2008 $cache = ObjectCache
::getLocalClusterInstance();
2012 if ( isset( $limits['anon'] ) ) {
2013 $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
2015 } elseif ( isset( $limits['user'] ) ) {
2016 // limits for logged-in users
2017 $userLimit = $limits['user'];
2020 // limits for anons and for newbie logged-in users
2023 if ( isset( $limits['ip'] ) ) {
2024 $ip = $this->getRequest()->getIP();
2025 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
2027 // subnet-based limits
2028 if ( isset( $limits['subnet'] ) ) {
2029 $ip = $this->getRequest()->getIP();
2030 $subnet = IP
::getSubnet( $ip );
2031 if ( $subnet !== false ) {
2032 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
2037 // Check for group-specific permissions
2038 // If more than one group applies, use the group with the highest limit ratio (max/period)
2039 foreach ( $this->getGroups() as $group ) {
2040 if ( isset( $limits[$group] ) ) {
2041 if ( $userLimit === false
2042 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
2044 $userLimit = $limits[$group];
2049 // limits for newbie logged-in users (override all the normal user limits)
2050 if ( $id !== 0 && $isNewbie && isset( $limits['newbie'] ) ) {
2051 $userLimit = $limits['newbie'];
2054 // Set the user limit key
2055 if ( $userLimit !== false ) {
2056 // phan is confused because &can-bypass's value is a bool, so it assumes
2057 // that $userLimit is also a bool here.
2058 // @phan-suppress-next-line PhanTypeInvalidExpressionArrayDestructuring
2059 list( $max, $period ) = $userLimit;
2060 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
2061 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
2064 // ip-based limits for all ping-limitable users
2065 if ( isset( $limits['ip-all'] ) ) {
2066 $ip = $this->getRequest()->getIP();
2067 // ignore if user limit is more permissive
2068 if ( $isNewbie ||
$userLimit === false
2069 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
2070 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
2074 // subnet-based limits for all ping-limitable users
2075 if ( isset( $limits['subnet-all'] ) ) {
2076 $ip = $this->getRequest()->getIP();
2077 $subnet = IP
::getSubnet( $ip );
2078 if ( $subnet !== false ) {
2079 // ignore if user limit is more permissive
2080 if ( $isNewbie ||
$userLimit === false
2081 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
2082 > $userLimit[0] / $userLimit[1] ) {
2083 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
2089 foreach ( $keys as $key => $limit ) {
2090 // phan is confused because &can-bypass's value is a bool, so it assumes
2091 // that $userLimit is also a bool here.
2092 // @phan-suppress-next-line PhanTypeInvalidExpressionArrayDestructuring
2093 list( $max, $period ) = $limit;
2094 $summary = "(limit $max in {$period}s)";
2095 $count = $cache->get( $key );
2098 if ( $count >= $max ) {
2099 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
2100 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
2103 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
2106 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
2107 if ( $incrBy > 0 ) {
2108 $cache->add( $key, 0, intval( $period ) ); // first ping
2111 if ( $incrBy > 0 ) {
2112 $cache->incr( $key, $incrBy );
2120 * Check if user is blocked
2122 * @deprecated since 1.34, use User::getBlock() or
2123 * PermissionManager::isBlockedFrom() or
2124 * PermissionManager::userCan() instead.
2126 * @param bool $fromReplica Whether to check the replica DB instead of
2127 * the master. Hacked from false due to horrible probs on site.
2128 * @return bool True if blocked, false otherwise
2130 public function isBlocked( $fromReplica = true ) {
2131 return $this->getBlock( $fromReplica ) instanceof AbstractBlock
&&
2132 $this->getBlock()->appliesToRight( 'edit' );
2136 * Get the block affecting the user, or null if the user is not blocked
2138 * @param bool $fromReplica Whether to check the replica DB instead of the master
2139 * @return AbstractBlock|null
2141 public function getBlock( $fromReplica = true ) {
2142 $this->getBlockedStatus( $fromReplica );
2143 return $this->mBlock
instanceof AbstractBlock ?
$this->mBlock
: null;
2147 * Check if user is blocked from editing a particular article
2149 * @param Title $title Title to check
2150 * @param bool $fromReplica Whether to check the replica DB instead of the master
2152 * @throws MWException
2154 * @deprecated since 1.33,
2155 * use MediaWikiServices::getInstance()->getPermissionManager()->isBlockedFrom(..)
2158 public function isBlockedFrom( $title, $fromReplica = false ) {
2159 return MediaWikiServices
::getInstance()->getPermissionManager()
2160 ->isBlockedFrom( $this, $title, $fromReplica );
2164 * If user is blocked, return the name of the user who placed the block
2165 * @return string Name of blocker
2167 public function blockedBy() {
2168 $this->getBlockedStatus();
2169 return $this->mBlockedby
;
2173 * If user is blocked, return the specified reason for the block
2174 * @return string Blocking reason
2176 public function blockedFor() {
2177 $this->getBlockedStatus();
2178 return $this->mBlockreason
;
2182 * If user is blocked, return the ID for the block
2183 * @return int Block ID
2185 public function getBlockId() {
2186 $this->getBlockedStatus();
2187 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2191 * Check if user is blocked on all wikis.
2192 * Do not use for actual edit permission checks!
2193 * This is intended for quick UI checks.
2195 * @param string $ip IP address, uses current client if none given
2196 * @return bool True if blocked, false otherwise
2198 public function isBlockedGlobally( $ip = '' ) {
2199 return $this->getGlobalBlock( $ip ) instanceof AbstractBlock
;
2203 * Check if user is blocked on all wikis.
2204 * Do not use for actual edit permission checks!
2205 * This is intended for quick UI checks.
2207 * @param string $ip IP address, uses current client if none given
2208 * @return AbstractBlock|null Block object if blocked, null otherwise
2209 * @throws FatalError
2210 * @throws MWException
2212 public function getGlobalBlock( $ip = '' ) {
2213 if ( $this->mGlobalBlock
!== null ) {
2214 return $this->mGlobalBlock ?
: null;
2216 // User is already an IP?
2217 if ( IP
::isIPAddress( $this->getName() ) ) {
2218 $ip = $this->getName();
2220 $ip = $this->getRequest()->getIP();
2222 // Avoid PHP 7.1 warning of passing $this by reference
2226 Hooks
::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
2228 if ( $blocked && $block === null ) {
2229 // back-compat: UserIsBlockedGlobally didn't have $block param first
2230 $block = new SystemBlock( [
2232 'systemBlock' => 'global-block'
2236 $this->mGlobalBlock
= $blocked ?
$block : false;
2237 return $this->mGlobalBlock ?
: null;
2241 * Check if user account is locked
2243 * @return bool True if locked, false otherwise
2245 public function isLocked() {
2246 if ( $this->mLocked
!== null ) {
2247 return $this->mLocked
;
2250 $this->mLocked
= false;
2251 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2252 return $this->mLocked
;
2256 * Check if user account is hidden
2258 * @return bool True if hidden, false otherwise
2260 public function isHidden() {
2261 if ( $this->mHideName
!== null ) {
2262 return (bool)$this->mHideName
;
2264 $this->getBlockedStatus();
2265 if ( !$this->mHideName
) {
2267 $this->mHideName
= false;
2268 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2270 return (bool)$this->mHideName
;
2274 * Get the user's ID.
2275 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2277 public function getId() {
2278 if ( $this->mId
=== null && $this->mName
!== null && self
::isIP( $this->mName
) ) {
2279 // Special case, we know the user is anonymous
2283 if ( !$this->isItemLoaded( 'id' ) ) {
2284 // Don't load if this was initialized from an ID
2288 return (int)$this->mId
;
2292 * Set the user and reload all fields according to a given ID
2293 * @param int $v User ID to reload
2295 public function setId( $v ) {
2297 $this->clearInstanceCache( 'id' );
2301 * Get the user name, or the IP of an anonymous user
2302 * @return string User's name or IP address
2304 public function getName() {
2305 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2306 // Special case optimisation
2307 return $this->mName
;
2311 if ( $this->mName
=== false ) {
2313 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2316 return $this->mName
;
2320 * Set the user name.
2322 * This does not reload fields from the database according to the given
2323 * name. Rather, it is used to create a temporary "nonexistent user" for
2324 * later addition to the database. It can also be used to set the IP
2325 * address for an anonymous user to something other than the current
2328 * @note User::newFromName() has roughly the same function, when the named user
2330 * @param string $str New user name to set
2332 public function setName( $str ) {
2334 $this->mName
= $str;
2338 * Get the user's actor ID.
2340 * @param IDatabase|null $dbw Assign a new actor ID, using this DB handle, if none exists
2341 * @return int The actor's ID, or 0 if no actor ID exists and $dbw was null
2343 public function getActorId( IDatabase
$dbw = null ) {
2344 global $wgActorTableSchemaMigrationStage;
2346 // Technically we should always return 0 without SCHEMA_COMPAT_READ_NEW,
2347 // but it does little harm and might be needed for write callers loading a User.
2348 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) ) {
2352 if ( !$this->isItemLoaded( 'actor' ) ) {
2356 // Currently $this->mActorId might be null if $this was loaded from a
2357 // cache entry that was written when $wgActorTableSchemaMigrationStage
2358 // was SCHEMA_COMPAT_OLD. Once that is no longer a possibility (i.e. when
2359 // User::VERSION is incremented after $wgActorTableSchemaMigrationStage
2360 // has been removed), that condition may be removed.
2361 if ( $this->mActorId
=== null ||
!$this->mActorId
&& $dbw ) {
2363 'actor_user' => $this->getId() ?
: null,
2364 'actor_name' => (string)$this->getName(),
2367 if ( $q['actor_user'] === null && self
::isUsableName( $q['actor_name'] ) ) {
2368 throw new CannotCreateActorException(
2369 'Cannot create an actor for a usable name that is not an existing user'
2372 if ( $q['actor_name'] === '' ) {
2373 throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
2375 $dbw->insert( 'actor', $q, __METHOD__
, [ 'IGNORE' ] );
2376 if ( $dbw->affectedRows() ) {
2377 $this->mActorId
= (int)$dbw->insertId();
2380 // Use LOCK IN SHARE MODE to bypass any MySQL REPEATABLE-READ snapshot.
2381 $this->mActorId
= (int)$dbw->selectField(
2386 [ 'LOCK IN SHARE MODE' ]
2388 if ( !$this->mActorId
) {
2389 throw new CannotCreateActorException(
2390 "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
2394 $this->invalidateCache();
2396 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2397 $db = wfGetDB( $index );
2398 $this->mActorId
= (int)$db->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2400 $this->setItemLoaded( 'actor' );
2403 return (int)$this->mActorId
;
2407 * Get the user's name escaped by underscores.
2408 * @return string Username escaped by underscores.
2410 public function getTitleKey() {
2411 return str_replace( ' ', '_', $this->getName() );
2415 * Check if the user has new messages.
2416 * @return bool True if the user has new messages
2418 public function getNewtalk() {
2421 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2422 if ( $this->mNewtalk
=== -1 ) {
2423 $this->mNewtalk
= false; # reset talk page status
2425 // Check memcached separately for anons, who have no
2426 // entire User object stored in there.
2427 if ( !$this->mId
) {
2428 global $wgDisableAnonTalk;
2429 if ( $wgDisableAnonTalk ) {
2430 // Anon newtalk disabled by configuration.
2431 $this->mNewtalk
= false;
2433 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2436 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2440 return (bool)$this->mNewtalk
;
2444 * Return the data needed to construct links for new talk page message
2445 * alerts. If there are new messages, this will return an associative array
2446 * with the following data:
2447 * wiki: The database name of the wiki
2448 * link: Root-relative link to the user's talk page
2449 * rev: The last talk page revision that the user has seen or null. This
2450 * is useful for building diff links.
2451 * If there are no new messages, it returns an empty array.
2452 * @note This function was designed to accomodate multiple talk pages, but
2453 * currently only returns a single link and revision.
2456 public function getNewMessageLinks() {
2457 // Avoid PHP 7.1 warning of passing $this by reference
2460 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
2464 if ( !$this->getNewtalk() ) {
2467 $utp = $this->getTalkPage();
2468 $dbr = wfGetDB( DB_REPLICA
);
2469 // Get the "last viewed rev" timestamp from the oldest message notification
2470 $timestamp = $dbr->selectField( 'user_newtalk',
2471 'MIN(user_last_timestamp)',
2472 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2474 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2477 'wiki' => WikiMap
::getWikiIdFromDbDomain( WikiMap
::getCurrentWikiDbDomain() ),
2478 'link' => $utp->getLocalURL(),
2485 * Get the revision ID for the last talk page revision viewed by the talk
2487 * @return int|null Revision ID or null
2489 public function getNewMessageRevisionId() {
2490 $newMessageRevisionId = null;
2491 $newMessageLinks = $this->getNewMessageLinks();
2493 // Note: getNewMessageLinks() never returns more than a single link
2494 // and it is always for the same wiki, but we double-check here in
2495 // case that changes some time in the future.
2496 if ( $newMessageLinks && count( $newMessageLinks ) === 1
2497 && WikiMap
::isCurrentWikiId( $newMessageLinks[0]['wiki'] )
2498 && $newMessageLinks[0]['rev']
2500 /** @var Revision $newMessageRevision */
2501 $newMessageRevision = $newMessageLinks[0]['rev'];
2502 $newMessageRevisionId = $newMessageRevision->getId();
2505 return $newMessageRevisionId;
2509 * Internal uncached check for new messages
2512 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2513 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2514 * @return bool True if the user has new messages
2516 protected function checkNewtalk( $field, $id ) {
2517 $dbr = wfGetDB( DB_REPLICA
);
2519 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2521 return $ok !== false;
2525 * Add or update the new messages flag
2526 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2527 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2528 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2529 * @return bool True if successful, false otherwise
2531 protected function updateNewtalk( $field, $id, $curRev = null ) {
2532 // Get timestamp of the talk page revision prior to the current one
2533 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2534 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2535 // Mark the user as having new messages since this revision
2536 $dbw = wfGetDB( DB_MASTER
);
2537 $dbw->insert( 'user_newtalk',
2538 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2541 if ( $dbw->affectedRows() ) {
2542 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2546 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2551 * Clear the new messages flag for the given user
2552 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2553 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2554 * @return bool True if successful, false otherwise
2556 protected function deleteNewtalk( $field, $id ) {
2557 $dbw = wfGetDB( DB_MASTER
);
2558 $dbw->delete( 'user_newtalk',
2561 if ( $dbw->affectedRows() ) {
2562 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2566 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2571 * Update the 'You have new messages!' status.
2572 * @param bool $val Whether the user has new messages
2573 * @param Revision|null $curRev New, as yet unseen revision of the user talk
2574 * page. Ignored if null or !$val.
2576 public function setNewtalk( $val, $curRev = null ) {
2577 if ( wfReadOnly() ) {
2582 $this->mNewtalk
= $val;
2584 if ( $this->isAnon() ) {
2586 $id = $this->getName();
2589 $id = $this->getId();
2593 $changed = $this->updateNewtalk( $field, $id, $curRev );
2595 $changed = $this->deleteNewtalk( $field, $id );
2599 $this->invalidateCache();
2604 * Generate a current or new-future timestamp to be stored in the
2605 * user_touched field when we update things.
2607 * @return string Timestamp in TS_MW format
2609 private function newTouchedTimestamp() {
2611 if ( $this->mTouched
) {
2612 $time = max( $time, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2615 return wfTimestamp( TS_MW
, $time );
2619 * Clear user data from memcached
2621 * Use after applying updates to the database; caller's
2622 * responsibility to update user_touched if appropriate.
2624 * Called implicitly from invalidateCache() and saveSettings().
2626 * @param string $mode Use 'refresh' to clear now or 'changed' to clear before DB commit
2628 public function clearSharedCache( $mode = 'refresh' ) {
2629 if ( !$this->getId() ) {
2633 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2634 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2635 $key = $this->getCacheKey( $cache );
2637 if ( $mode === 'refresh' ) {
2638 $cache->delete( $key, 1 ); // low tombstone/"hold-off" TTL
2640 $lb->getConnection( DB_MASTER
)->onTransactionPreCommitOrIdle(
2641 function () use ( $cache, $key ) {
2642 $cache->delete( $key );
2650 * Immediately touch the user data cache for this account
2652 * Calls touch() and removes account data from memcached
2654 public function invalidateCache() {
2656 $this->clearSharedCache( 'changed' );
2660 * Update the "touched" timestamp for the user
2662 * This is useful on various login/logout events when making sure that
2663 * a browser or proxy that has multiple tenants does not suffer cache
2664 * pollution where the new user sees the old users content. The value
2665 * of getTouched() is checked when determining 304 vs 200 responses.
2666 * Unlike invalidateCache(), this preserves the User object cache and
2667 * avoids database writes.
2671 public function touch() {
2672 $id = $this->getId();
2674 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2675 $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
2676 $cache->touchCheckKey( $key );
2677 $this->mQuickTouched
= null;
2682 * Validate the cache for this account.
2683 * @param string $timestamp A timestamp in TS_MW format
2686 public function validateCache( $timestamp ) {
2687 return ( $timestamp >= $this->getTouched() );
2691 * Get the user touched timestamp
2693 * Use this value only to validate caches via inequalities
2694 * such as in the case of HTTP If-Modified-Since response logic
2696 * @return string TS_MW Timestamp
2698 public function getTouched() {
2702 if ( $this->mQuickTouched
=== null ) {
2703 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2704 $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId
);
2706 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2709 return max( $this->mTouched
, $this->mQuickTouched
);
2712 return $this->mTouched
;
2716 * Get the user_touched timestamp field (time of last DB updates)
2717 * @return string TS_MW Timestamp
2720 public function getDBTouched() {
2723 return $this->mTouched
;
2727 * Set the password and reset the random token.
2728 * Calls through to authentication plugin if necessary;
2729 * will have no effect if the auth plugin refuses to
2730 * pass the change through or if the legal password
2733 * As a special case, setting the password to null
2734 * wipes it, so the account cannot be logged in until
2735 * a new password is set, for instance via e-mail.
2737 * @deprecated since 1.27, use AuthManager instead
2738 * @param string $str New password to set
2739 * @throws PasswordError On failure
2742 public function setPassword( $str ) {
2743 wfDeprecated( __METHOD__
, '1.27' );
2744 return $this->setPasswordInternal( $str );
2748 * Set the password and reset the random token unconditionally.
2750 * @deprecated since 1.27, use AuthManager instead
2751 * @param string|null $str New password to set or null to set an invalid
2752 * password hash meaning that the user will not be able to log in
2753 * through the web interface.
2755 public function setInternalPassword( $str ) {
2756 wfDeprecated( __METHOD__
, '1.27' );
2757 $this->setPasswordInternal( $str );
2761 * Actually set the password and such
2762 * @since 1.27 cannot set a password for a user not in the database
2763 * @param string|null $str New password to set or null to set an invalid
2764 * password hash meaning that the user will not be able to log in
2765 * through the web interface.
2766 * @return bool Success
2768 private function setPasswordInternal( $str ) {
2769 $manager = AuthManager
::singleton();
2771 // If the user doesn't exist yet, fail
2772 if ( !$manager->userExists( $this->getName() ) ) {
2773 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2776 $status = $this->changeAuthenticationData( [
2777 'username' => $this->getName(),
2781 if ( !$status->isGood() ) {
2782 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2783 ->info( __METHOD__
. ': Password change rejected: '
2784 . $status->getWikiText( null, null, 'en' ) );
2788 $this->setOption( 'watchlisttoken', false );
2789 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2795 * Changes credentials of the user.
2797 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2798 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2799 * e.g. when no provider handled the change.
2801 * @param array $data A set of authentication data in fieldname => value format. This is the
2802 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2806 public function changeAuthenticationData( array $data ) {
2807 $manager = AuthManager
::singleton();
2808 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2809 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2811 $status = Status
::newGood( 'ignored' );
2812 foreach ( $reqs as $req ) {
2813 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2815 if ( $status->getValue() === 'ignored' ) {
2816 $status->warning( 'authenticationdatachange-ignored' );
2819 if ( $status->isGood() ) {
2820 foreach ( $reqs as $req ) {
2821 $manager->changeAuthenticationData( $req );
2828 * Get the user's current token.
2829 * @param bool $forceCreation Force the generation of a new token if the
2830 * user doesn't have one (default=true for backwards compatibility).
2831 * @return string|null Token
2833 public function getToken( $forceCreation = true ) {
2834 global $wgAuthenticationTokenVersion;
2837 if ( !$this->mToken
&& $forceCreation ) {
2841 if ( !$this->mToken
) {
2842 // The user doesn't have a token, return null to indicate that.
2846 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
2847 // We return a random value here so existing token checks are very
2849 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2852 if ( $wgAuthenticationTokenVersion === null ) {
2853 // $wgAuthenticationTokenVersion not in use, so return the raw secret
2854 return $this->mToken
;
2857 // $wgAuthenticationTokenVersion in use, so hmac it.
2858 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
2860 // The raw hash can be overly long. Shorten it up.
2861 $len = max( 32, self
::TOKEN_LENGTH
);
2862 if ( strlen( $ret ) < $len ) {
2863 // Should never happen, even md5 is 128 bits
2864 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
2867 return substr( $ret, -$len );
2871 * Set the random token (used for persistent authentication)
2872 * Called from loadDefaults() among other places.
2874 * @param string|bool $token If specified, set the token to this value
2876 public function setToken( $token = false ) {
2878 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
2879 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
2880 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
2881 } elseif ( !$token ) {
2882 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2884 $this->mToken
= $token;
2889 * Set the password for a password reminder or new account email
2891 * @deprecated Removed in 1.27. Use PasswordReset instead.
2892 * @param string $str New password to set or null to set an invalid
2893 * password hash meaning that the user will not be able to use it
2894 * @param bool $throttle If true, reset the throttle timestamp to the present
2896 public function setNewpassword( $str, $throttle = true ) {
2897 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2901 * Get the user's e-mail address
2902 * @return string User's email address
2904 public function getEmail() {
2906 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
2907 return $this->mEmail
;
2911 * Get the timestamp of the user's e-mail authentication
2912 * @return string TS_MW timestamp
2914 public function getEmailAuthenticationTimestamp() {
2916 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
2917 return $this->mEmailAuthenticated
;
2921 * Set the user's e-mail address
2922 * @param string $str New e-mail address
2924 public function setEmail( $str ) {
2926 if ( $str == $this->mEmail
) {
2929 $this->invalidateEmail();
2930 $this->mEmail
= $str;
2931 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
2935 * Set the user's e-mail address and a confirmation mail if needed.
2938 * @param string $str New e-mail address
2941 public function setEmailWithConfirmation( $str ) {
2942 global $wgEnableEmail, $wgEmailAuthentication;
2944 if ( !$wgEnableEmail ) {
2945 return Status
::newFatal( 'emaildisabled' );
2948 $oldaddr = $this->getEmail();
2949 if ( $str === $oldaddr ) {
2950 return Status
::newGood( true );
2953 $type = $oldaddr != '' ?
'changed' : 'set';
2954 $notificationResult = null;
2956 if ( $wgEmailAuthentication && $type === 'changed' ) {
2957 // Send the user an email notifying the user of the change in registered
2958 // email address on their previous email address
2959 $change = $str != '' ?
'changed' : 'removed';
2960 $notificationResult = $this->sendMail(
2961 wfMessage( 'notificationemail_subject_' . $change )->text(),
2962 wfMessage( 'notificationemail_body_' . $change,
2963 $this->getRequest()->getIP(),
2969 $this->setEmail( $str );
2971 if ( $str !== '' && $wgEmailAuthentication ) {
2972 // Send a confirmation request to the new address if needed
2973 $result = $this->sendConfirmationMail( $type );
2975 if ( $notificationResult !== null ) {
2976 $result->merge( $notificationResult );
2979 if ( $result->isGood() ) {
2980 // Say to the caller that a confirmation and notification mail has been sent
2981 $result->value
= 'eauth';
2984 $result = Status
::newGood( true );
2991 * Get the user's real name
2992 * @return string User's real name
2994 public function getRealName() {
2995 if ( !$this->isItemLoaded( 'realname' ) ) {
2999 return $this->mRealName
;
3003 * Set the user's real name
3004 * @param string $str New real name
3006 public function setRealName( $str ) {
3008 $this->mRealName
= $str;
3012 * Get the user's current setting for a given option.
3014 * @param string $oname The option to check
3015 * @param string|array|null $defaultOverride A default value returned if the option does not exist
3016 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
3017 * @return string|array|int|null User's current value for the option
3018 * @see getBoolOption()
3019 * @see getIntOption()
3021 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
3022 global $wgHiddenPrefs;
3023 $this->loadOptions();
3025 # We want 'disabled' preferences to always behave as the default value for
3026 # users, even if they have set the option explicitly in their settings (ie they
3027 # set it, and then it was disabled removing their ability to change it). But
3028 # we don't want to erase the preferences in the database in case the preference
3029 # is re-enabled again. So don't touch $mOptions, just override the returned value
3030 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
3031 return self
::getDefaultOption( $oname );
3034 if ( array_key_exists( $oname, $this->mOptions
) ) {
3035 return $this->mOptions
[$oname];
3038 return $defaultOverride;
3042 * Get all user's options
3044 * @param int $flags Bitwise combination of:
3045 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
3046 * to the default value. (Since 1.25)
3049 public function getOptions( $flags = 0 ) {
3050 global $wgHiddenPrefs;
3051 $this->loadOptions();
3052 $options = $this->mOptions
;
3054 # We want 'disabled' preferences to always behave as the default value for
3055 # users, even if they have set the option explicitly in their settings (ie they
3056 # set it, and then it was disabled removing their ability to change it). But
3057 # we don't want to erase the preferences in the database in case the preference
3058 # is re-enabled again. So don't touch $mOptions, just override the returned value
3059 foreach ( $wgHiddenPrefs as $pref ) {
3060 $default = self
::getDefaultOption( $pref );
3061 if ( $default !== null ) {
3062 $options[$pref] = $default;
3066 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
3067 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
3074 * Get the user's current setting for a given option, as a boolean value.
3076 * @param string $oname The option to check
3077 * @return bool User's current value for the option
3080 public function getBoolOption( $oname ) {
3081 return (bool)$this->getOption( $oname );
3085 * Get the user's current setting for a given option, as an integer value.
3087 * @param string $oname The option to check
3088 * @param int $defaultOverride A default value returned if the option does not exist
3089 * @return int User's current value for the option
3092 public function getIntOption( $oname, $defaultOverride = 0 ) {
3093 $val = $this->getOption( $oname );
3095 $val = $defaultOverride;
3097 return intval( $val );
3101 * Set the given option for a user.
3103 * You need to call saveSettings() to actually write to the database.
3105 * @param string $oname The option to set
3106 * @param mixed $val New value to set
3108 public function setOption( $oname, $val ) {
3109 $this->loadOptions();
3111 // Explicitly NULL values should refer to defaults
3112 if ( is_null( $val ) ) {
3113 $val = self
::getDefaultOption( $oname );
3116 $this->mOptions
[$oname] = $val;
3120 * Get a token stored in the preferences (like the watchlist one),
3121 * resetting it if it's empty (and saving changes).
3123 * @param string $oname The option name to retrieve the token from
3124 * @return string|bool User's current value for the option, or false if this option is disabled.
3125 * @see resetTokenFromOption()
3127 * @deprecated since 1.26 Applications should use the OAuth extension
3129 public function getTokenFromOption( $oname ) {
3130 global $wgHiddenPrefs;
3132 $id = $this->getId();
3133 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
3137 $token = $this->getOption( $oname );
3139 // Default to a value based on the user token to avoid space
3140 // wasted on storing tokens for all users. When this option
3141 // is set manually by the user, only then is it stored.
3142 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
3149 * Reset a token stored in the preferences (like the watchlist one).
3150 * *Does not* save user's preferences (similarly to setOption()).
3152 * @param string $oname The option name to reset the token in
3153 * @return string|bool New token value, or false if this option is disabled.
3154 * @see getTokenFromOption()
3157 public function resetTokenFromOption( $oname ) {
3158 global $wgHiddenPrefs;
3159 if ( in_array( $oname, $wgHiddenPrefs ) ) {
3163 $token = MWCryptRand
::generateHex( 40 );
3164 $this->setOption( $oname, $token );
3169 * Return a list of the types of user options currently returned by
3170 * User::getOptionKinds().
3172 * Currently, the option kinds are:
3173 * - 'registered' - preferences which are registered in core MediaWiki or
3174 * by extensions using the UserGetDefaultOptions hook.
3175 * - 'registered-multiselect' - as above, using the 'multiselect' type.
3176 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
3177 * - 'userjs' - preferences with names starting with 'userjs-', intended to
3178 * be used by user scripts.
3179 * - 'special' - "preferences" that are not accessible via User::getOptions
3180 * or User::setOptions.
3181 * - 'unused' - preferences about which MediaWiki doesn't know anything.
3182 * These are usually legacy options, removed in newer versions.
3184 * The API (and possibly others) use this function to determine the possible
3185 * option types for validation purposes, so make sure to update this when a
3186 * new option kind is added.
3188 * @see User::getOptionKinds
3189 * @return array Option kinds
3191 public static function listOptionKinds() {
3194 'registered-multiselect',
3195 'registered-checkmatrix',
3203 * Return an associative array mapping preferences keys to the kind of a preference they're
3204 * used for. Different kinds are handled differently when setting or reading preferences.
3206 * See User::listOptionKinds for the list of valid option types that can be provided.
3208 * @see User::listOptionKinds
3209 * @param IContextSource $context
3210 * @param array|null $options Assoc. array with options keys to check as keys.
3211 * Defaults to $this->mOptions.
3212 * @return array The key => kind mapping data
3214 public function getOptionKinds( IContextSource
$context, $options = null ) {
3215 $this->loadOptions();
3216 if ( $options === null ) {
3217 $options = $this->mOptions
;
3220 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
3221 $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
3224 // Pull out the "special" options, so they don't get converted as
3225 // multiselect or checkmatrix.
3226 $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
3227 foreach ( $specialOptions as $name => $value ) {
3228 unset( $prefs[$name] );
3231 // Multiselect and checkmatrix options are stored in the database with
3232 // one key per option, each having a boolean value. Extract those keys.
3233 $multiselectOptions = [];
3234 foreach ( $prefs as $name => $info ) {
3235 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3236 ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField
::class ) ) {
3237 $opts = HTMLFormField
::flattenOptions( $info['options'] );
3238 $prefix = $info['prefix'] ??
$name;
3240 foreach ( $opts as $value ) {
3241 $multiselectOptions["$prefix$value"] = true;
3244 unset( $prefs[$name] );
3247 $checkmatrixOptions = [];
3248 foreach ( $prefs as $name => $info ) {
3249 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3250 ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix
::class ) ) {
3251 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3252 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3253 $prefix = $info['prefix'] ??
$name;
3255 foreach ( $columns as $column ) {
3256 foreach ( $rows as $row ) {
3257 $checkmatrixOptions["$prefix$column-$row"] = true;
3261 unset( $prefs[$name] );
3265 // $value is ignored
3266 foreach ( $options as $key => $value ) {
3267 if ( isset( $prefs[$key] ) ) {
3268 $mapping[$key] = 'registered';
3269 } elseif ( isset( $multiselectOptions[$key] ) ) {
3270 $mapping[$key] = 'registered-multiselect';
3271 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3272 $mapping[$key] = 'registered-checkmatrix';
3273 } elseif ( isset( $specialOptions[$key] ) ) {
3274 $mapping[$key] = 'special';
3275 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3276 $mapping[$key] = 'userjs';
3278 $mapping[$key] = 'unused';
3286 * Reset certain (or all) options to the site defaults
3288 * The optional parameter determines which kinds of preferences will be reset.
3289 * Supported values are everything that can be reported by getOptionKinds()
3290 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3292 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3293 * [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ]
3294 * for backwards-compatibility.
3295 * @param IContextSource|null $context Context source used when $resetKinds
3296 * does not contain 'all', passed to getOptionKinds().
3297 * Defaults to RequestContext::getMain() when null.
3299 public function resetOptions(
3300 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3301 IContextSource
$context = null
3304 $defaultOptions = self
::getDefaultOptions();
3306 if ( !is_array( $resetKinds ) ) {
3307 $resetKinds = [ $resetKinds ];
3310 if ( in_array( 'all', $resetKinds ) ) {
3311 $newOptions = $defaultOptions;
3313 if ( $context === null ) {
3314 $context = RequestContext
::getMain();
3317 $optionKinds = $this->getOptionKinds( $context );
3318 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3321 // Use default values for the options that should be deleted, and
3322 // copy old values for the ones that shouldn't.
3323 foreach ( $this->mOptions
as $key => $value ) {
3324 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3325 if ( array_key_exists( $key, $defaultOptions ) ) {
3326 $newOptions[$key] = $defaultOptions[$key];
3329 $newOptions[$key] = $value;
3334 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3336 $this->mOptions
= $newOptions;
3337 $this->mOptionsLoaded
= true;
3341 * Get the user's preferred date format.
3342 * @return string User's preferred date format
3344 public function getDatePreference() {
3345 // Important migration for old data rows
3346 if ( is_null( $this->mDatePreference
) ) {
3348 $value = $this->getOption( 'date' );
3349 $map = $wgLang->getDatePreferenceMigrationMap();
3350 if ( isset( $map[$value] ) ) {
3351 $value = $map[$value];
3353 $this->mDatePreference
= $value;
3355 return $this->mDatePreference
;
3359 * Determine based on the wiki configuration and the user's options,
3360 * whether this user must be over HTTPS no matter what.
3364 public function requiresHTTPS() {
3365 global $wgSecureLogin;
3366 if ( !$wgSecureLogin ) {
3370 $https = $this->getBoolOption( 'prefershttps' );
3371 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3373 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3380 * Get the user preferred stub threshold
3384 public function getStubThreshold() {
3385 global $wgMaxArticleSize; # Maximum article size, in Kb
3386 $threshold = $this->getIntOption( 'stubthreshold' );
3387 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3388 // If they have set an impossible value, disable the preference
3389 // so we can use the parser cache again.
3396 * Get the permissions this user has.
3397 * @return string[] permission names
3399 public function getRights() {
3400 if ( is_null( $this->mRights
) ) {
3401 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3402 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3404 // Deny any rights denied by the user's session, unless this
3405 // endpoint has no sessions.
3406 if ( !defined( 'MW_NO_SESSION' ) ) {
3407 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3408 if ( $allowedRights !== null ) {
3409 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3413 Hooks
::run( 'UserGetRightsRemove', [ $this, &$this->mRights
] );
3414 // Force reindexation of rights when a hook has unset one of them
3415 $this->mRights
= array_values( array_unique( $this->mRights
) );
3417 // If block disables login, we should also remove any
3418 // extra rights blocked users might have, in case the
3419 // blocked user has a pre-existing session (T129738).
3420 // This is checked here for cases where people only call
3421 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3422 // to give a better error message in the common case.
3423 $config = RequestContext
::getMain()->getConfig();
3424 // @TODO Partial blocks should not prevent the user from logging in.
3425 // see: https://phabricator.wikimedia.org/T208895
3427 $this->isLoggedIn() &&
3428 $config->get( 'BlockDisablesLogin' ) &&
3432 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3435 return $this->mRights
;
3439 * Get the list of explicit group memberships this user has.
3440 * The implicit * and user groups are not included.
3442 * @return string[] Array of internal group names (sorted since 1.33)
3444 public function getGroups() {
3446 $this->loadGroups();
3447 return array_keys( $this->mGroupMemberships
);
3451 * Get the list of explicit group memberships this user has, stored as
3452 * UserGroupMembership objects. Implicit groups are not included.
3454 * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
3457 public function getGroupMemberships() {
3459 $this->loadGroups();
3460 return $this->mGroupMemberships
;
3464 * Get the list of implicit group memberships this user has.
3465 * This includes all explicit groups, plus 'user' if logged in,
3466 * '*' for all accounts, and autopromoted groups
3467 * @param bool $recache Whether to avoid the cache
3468 * @return array Array of String internal group names
3470 public function getEffectiveGroups( $recache = false ) {
3471 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3472 $this->mEffectiveGroups
= array_unique( array_merge(
3473 $this->getGroups(), // explicit groups
3474 $this->getAutomaticGroups( $recache ) // implicit groups
3476 // Avoid PHP 7.1 warning of passing $this by reference
3478 // Hook for additional groups
3479 Hooks
::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups
] );
3480 // Force reindexation of groups when a hook has unset one of them
3481 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3483 return $this->mEffectiveGroups
;
3487 * Get the list of implicit group memberships this user has.
3488 * This includes 'user' if logged in, '*' for all accounts,
3489 * and autopromoted groups
3490 * @param bool $recache Whether to avoid the cache
3491 * @return array Array of String internal group names
3493 public function getAutomaticGroups( $recache = false ) {
3494 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3495 $this->mImplicitGroups
= [ '*' ];
3496 if ( $this->getId() ) {
3497 $this->mImplicitGroups
[] = 'user';
3499 $this->mImplicitGroups
= array_unique( array_merge(
3500 $this->mImplicitGroups
,
3501 Autopromote
::getAutopromoteGroups( $this )
3505 // Assure data consistency with rights/groups,
3506 // as getEffectiveGroups() depends on this function
3507 $this->mEffectiveGroups
= null;
3510 return $this->mImplicitGroups
;
3514 * Returns the groups the user has belonged to.
3516 * The user may still belong to the returned groups. Compare with getGroups().
3518 * The function will not return groups the user had belonged to before MW 1.17
3520 * @return array Names of the groups the user has belonged to.
3522 public function getFormerGroups() {
3525 if ( is_null( $this->mFormerGroups
) ) {
3526 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3527 ?
wfGetDB( DB_MASTER
)
3528 : wfGetDB( DB_REPLICA
);
3529 $res = $db->select( 'user_former_groups',
3531 [ 'ufg_user' => $this->mId
],
3533 $this->mFormerGroups
= [];
3534 foreach ( $res as $row ) {
3535 $this->mFormerGroups
[] = $row->ufg_group
;
3539 return $this->mFormerGroups
;
3543 * Get the user's edit count.
3544 * @return int|null Null for anonymous users
3546 public function getEditCount() {
3547 if ( !$this->getId() ) {
3551 if ( $this->mEditCount
=== null ) {
3552 /* Populate the count, if it has not been populated yet */
3553 $dbr = wfGetDB( DB_REPLICA
);
3554 // check if the user_editcount field has been initialized
3555 $count = $dbr->selectField(
3556 'user', 'user_editcount',
3557 [ 'user_id' => $this->mId
],
3561 if ( $count === null ) {
3562 // it has not been initialized. do so.
3563 $count = $this->initEditCountInternal();
3565 $this->mEditCount
= $count;
3567 return (int)$this->mEditCount
;
3571 * Add the user to the given group. This takes immediate effect.
3572 * If the user is already in the group, the expiry time will be updated to the new
3573 * expiry time. (If $expiry is omitted or null, the membership will be altered to
3576 * @param string $group Name of the group to add
3577 * @param string|null $expiry Optional expiry timestamp in any format acceptable to
3578 * wfTimestamp(), or null if the group assignment should not expire
3581 public function addGroup( $group, $expiry = null ) {
3583 $this->loadGroups();
3586 $expiry = wfTimestamp( TS_MW
, $expiry );
3589 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
3593 // create the new UserGroupMembership and put it in the DB
3594 $ugm = new UserGroupMembership( $this->mId
, $group, $expiry );
3595 if ( !$ugm->insert( true ) ) {
3599 $this->mGroupMemberships
[$group] = $ugm;
3601 // Refresh the groups caches, and clear the rights cache so it will be
3602 // refreshed on the next call to $this->getRights().
3603 $this->getEffectiveGroups( true );
3604 $this->mRights
= null;
3606 $this->invalidateCache();
3612 * Remove the user from the given group.
3613 * This takes immediate effect.
3614 * @param string $group Name of the group to remove
3617 public function removeGroup( $group ) {
3620 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3624 $ugm = UserGroupMembership
::getMembership( $this->mId
, $group );
3625 // delete the membership entry
3626 if ( !$ugm ||
!$ugm->delete() ) {
3630 $this->loadGroups();
3631 unset( $this->mGroupMemberships
[$group] );
3633 // Refresh the groups caches, and clear the rights cache so it will be
3634 // refreshed on the next call to $this->getRights().
3635 $this->getEffectiveGroups( true );
3636 $this->mRights
= null;
3638 $this->invalidateCache();
3644 * Alias of isLoggedIn() with a name that describes its actual functionality. UserIdentity has
3645 * only this new name and not the old isLoggedIn() variant.
3647 * @return bool True if user is registered on this wiki, i.e., has a user ID. False if user is
3648 * anonymous or has no local account (which can happen when importing). This is equivalent to
3649 * getId() != 0 and is provided for code readability.
3652 public function isRegistered() {
3653 return $this->getId() != 0;
3657 * Get whether the user is logged in
3660 public function isLoggedIn() {
3661 return $this->isRegistered();
3665 * Get whether the user is anonymous
3668 public function isAnon() {
3669 return !$this->isRegistered();
3673 * @return bool Whether this user is flagged as being a bot role account
3676 public function isBot() {
3677 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3682 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3688 * Check if user is allowed to access a feature / make an action
3690 * @param string $permissions,... Permissions to test
3691 * @return bool True if user is allowed to perform *any* of the given actions
3693 public function isAllowedAny() {
3694 $permissions = func_get_args();
3695 foreach ( $permissions as $permission ) {
3696 if ( $this->isAllowed( $permission ) ) {
3705 * @param string $permissions,... Permissions to test
3706 * @return bool True if the user is allowed to perform *all* of the given actions
3708 public function isAllowedAll() {
3709 $permissions = func_get_args();
3710 foreach ( $permissions as $permission ) {
3711 if ( !$this->isAllowed( $permission ) ) {
3719 * Internal mechanics of testing a permission
3720 * @param string $action
3723 public function isAllowed( $action = '' ) {
3724 if ( $action === '' ) {
3725 return true; // In the spirit of DWIM
3727 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3728 // by misconfiguration: 0 == 'foo'
3729 return in_array( $action, $this->getRights(), true );
3733 * Check whether to enable recent changes patrol features for this user
3734 * @return bool True or false
3736 public function useRCPatrol() {
3737 global $wgUseRCPatrol;
3738 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3742 * Check whether to enable new pages patrol features for this user
3743 * @return bool True or false
3745 public function useNPPatrol() {
3746 global $wgUseRCPatrol, $wgUseNPPatrol;
3748 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3749 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3754 * Check whether to enable new files patrol features for this user
3755 * @return bool True or false
3757 public function useFilePatrol() {
3758 global $wgUseRCPatrol, $wgUseFilePatrol;
3760 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3761 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3766 * Get the WebRequest object to use with this object
3768 * @return WebRequest
3770 public function getRequest() {
3771 if ( $this->mRequest
) {
3772 return $this->mRequest
;
3780 * Check the watched status of an article.
3781 * @since 1.22 $checkRights parameter added
3782 * @param Title $title Title of the article to look at
3783 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3784 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3787 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3788 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3789 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3796 * @since 1.22 $checkRights parameter added
3797 * @param Title $title Title of the article to look at
3798 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3799 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3801 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3802 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3803 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3805 [ $title->getSubjectPage(), $title->getTalkPage() ]
3808 $this->invalidateCache();
3812 * Stop watching an article.
3813 * @since 1.22 $checkRights parameter added
3814 * @param Title $title Title of the article to look at
3815 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3816 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3818 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3819 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3820 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3821 $store->removeWatch( $this, $title->getSubjectPage() );
3822 $store->removeWatch( $this, $title->getTalkPage() );
3824 $this->invalidateCache();
3828 * Clear the user's notification timestamp for the given title.
3829 * If e-notif e-mails are on, they will receive notification mails on
3830 * the next change of the page if it's watched etc.
3831 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3832 * @param Title &$title Title of the article to look at
3833 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3835 public function clearNotification( &$title, $oldid = 0 ) {
3836 global $wgUseEnotif, $wgShowUpdatedMarker;
3838 // Do nothing if the database is locked to writes
3839 if ( wfReadOnly() ) {
3843 // Do nothing if not allowed to edit the watchlist
3844 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3848 // If we're working on user's talk page, we should update the talk page message indicator
3849 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3850 // Avoid PHP 7.1 warning of passing $this by reference
3852 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
3856 // Try to update the DB post-send and only if needed...
3857 DeferredUpdates
::addCallableUpdate( function () use ( $title, $oldid ) {
3858 if ( !$this->getNewtalk() ) {
3859 return; // no notifications to clear
3862 // Delete the last notifications (they stack up)
3863 $this->setNewtalk( false );
3865 // If there is a new, unseen, revision, use its timestamp
3867 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
3870 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
3875 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3879 if ( $this->isAnon() ) {
3880 // Nothing else to do...
3884 // Only update the timestamp if the page is being watched.
3885 // The query to find out if it is watched is cached both in memcached and per-invocation,
3886 // and when it does have to be executed, it can be on a replica DB
3887 // If this is the user's newtalk page, we always update the timestamp
3889 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3893 MediaWikiServices
::getInstance()->getWatchedItemStore()
3894 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
3898 * Resets all of the given user's page-change notification timestamps.
3899 * If e-notif e-mails are on, they will receive notification mails on
3900 * the next change of any watched page.
3901 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3903 public function clearAllNotifications() {
3904 global $wgUseEnotif, $wgShowUpdatedMarker;
3905 // Do nothing if not allowed to edit the watchlist
3906 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
3910 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3911 $this->setNewtalk( false );
3915 $id = $this->getId();
3920 $watchedItemStore = MediaWikiServices
::getInstance()->getWatchedItemStore();
3921 $watchedItemStore->resetAllNotificationTimestampsForUser( $this );
3923 // We also need to clear here the "you have new message" notification for the own
3924 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
3928 * Compute experienced level based on edit count and registration date.
3930 * @return string 'newcomer', 'learner', or 'experienced'
3932 public function getExperienceLevel() {
3933 global $wgLearnerEdits,
3934 $wgExperiencedUserEdits,
3935 $wgLearnerMemberSince,
3936 $wgExperiencedUserMemberSince;
3938 if ( $this->isAnon() ) {
3942 $editCount = $this->getEditCount();
3943 $registration = $this->getRegistration();
3945 $learnerRegistration = wfTimestamp( TS_MW
, $now - $wgLearnerMemberSince * 86400 );
3946 $experiencedRegistration = wfTimestamp( TS_MW
, $now - $wgExperiencedUserMemberSince * 86400 );
3948 if ( $editCount < $wgLearnerEdits ||
3949 $registration > $learnerRegistration ) {
3953 if ( $editCount > $wgExperiencedUserEdits &&
3954 $registration <= $experiencedRegistration
3956 return 'experienced';
3963 * Persist this user's session (e.g. set cookies)
3965 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3967 * @param bool|null $secure Whether to force secure/insecure cookies or use default
3968 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3970 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3972 if ( $this->mId
== 0 ) {
3976 $session = $this->getRequest()->getSession();
3977 if ( $request && $session->getRequest() !== $request ) {
3978 $session = $session->sessionWithRequest( $request );
3980 $delay = $session->delaySave();
3982 if ( !$session->getUser()->equals( $this ) ) {
3983 if ( !$session->canSetUser() ) {
3984 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3985 ->warning( __METHOD__
.
3986 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
3990 $session->setUser( $this );
3993 $session->setRememberUser( $rememberMe );
3994 if ( $secure !== null ) {
3995 $session->setForceHTTPS( $secure );
3998 $session->persist();
4000 ScopedCallback
::consume( $delay );
4004 * Log this user out.
4006 public function logout() {
4007 // Avoid PHP 7.1 warning of passing $this by reference
4009 if ( Hooks
::run( 'UserLogout', [ &$user ] ) ) {
4015 * Clear the user's session, and reset the instance cache.
4018 public function doLogout() {
4019 $session = $this->getRequest()->getSession();
4020 if ( !$session->canSetUser() ) {
4021 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4022 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
4023 $error = 'immutable';
4024 } elseif ( !$session->getUser()->equals( $this ) ) {
4025 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4026 ->warning( __METHOD__
.
4027 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
4029 // But we still may as well make this user object anon
4030 $this->clearInstanceCache( 'defaults' );
4031 $error = 'wronguser';
4033 $this->clearInstanceCache( 'defaults' );
4034 $delay = $session->delaySave();
4035 $session->unpersist(); // Clear cookies (T127436)
4036 $session->setLoggedOutTimestamp( time() );
4037 $session->setUser( new User
);
4038 $session->set( 'wsUserID', 0 ); // Other code expects this
4039 $session->resetAllTokens();
4040 ScopedCallback
::consume( $delay );
4043 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
4044 'event' => 'logout',
4045 'successful' => $error === false,
4046 'status' => $error ?
: 'success',
4051 * Save this user's settings into the database.
4052 * @todo Only rarely do all these fields need to be set!
4054 public function saveSettings() {
4055 if ( wfReadOnly() ) {
4056 // @TODO: caller should deal with this instead!
4057 // This should really just be an exception.
4058 MWExceptionHandler
::logException( new DBExpectedError(
4060 "Could not update user with ID '{$this->mId}'; DB is read-only."
4066 if ( $this->mId
== 0 ) {
4070 // Get a new user_touched that is higher than the old one.
4071 // This will be used for a CAS check as a last-resort safety
4072 // check against race conditions and replica DB lag.
4073 $newTouched = $this->newTouchedTimestamp();
4075 $dbw = wfGetDB( DB_MASTER
);
4076 $dbw->doAtomicSection( __METHOD__
, function ( IDatabase
$dbw, $fname ) use ( $newTouched ) {
4077 global $wgActorTableSchemaMigrationStage;
4079 $dbw->update( 'user',
4081 'user_name' => $this->mName
,
4082 'user_real_name' => $this->mRealName
,
4083 'user_email' => $this->mEmail
,
4084 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4085 'user_touched' => $dbw->timestamp( $newTouched ),
4086 'user_token' => strval( $this->mToken
),
4087 'user_email_token' => $this->mEmailToken
,
4088 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
4089 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
4090 'user_id' => $this->mId
,
4094 if ( !$dbw->affectedRows() ) {
4095 // Maybe the problem was a missed cache update; clear it to be safe
4096 $this->clearSharedCache( 'refresh' );
4097 // User was changed in the meantime or loaded with stale data
4098 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
4099 LoggerFactory
::getInstance( 'preferences' )->warning(
4100 "CAS update failed on user_touched for user ID '{user_id}' ({db_flag} read)",
4101 [ 'user_id' => $this->mId
, 'db_flag' => $from ]
4103 throw new MWException( "CAS update failed on user_touched. " .
4104 "The version of the user to be saved is older than the current version."
4108 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4111 [ 'actor_name' => $this->mName
],
4112 [ 'actor_user' => $this->mId
],
4118 $this->mTouched
= $newTouched;
4119 $this->saveOptions();
4121 Hooks
::run( 'UserSaveSettings', [ $this ] );
4122 $this->clearSharedCache( 'changed' );
4123 $this->getUserPage()->purgeSquid();
4127 * If only this user's username is known, and it exists, return the user ID.
4129 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
4132 public function idForName( $flags = 0 ) {
4133 $s = trim( $this->getName() );
4138 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
4139 ?
wfGetDB( DB_MASTER
)
4140 : wfGetDB( DB_REPLICA
);
4142 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
4143 ?
[ 'LOCK IN SHARE MODE' ]
4146 $id = $db->selectField( 'user',
4147 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
4153 * Add a user to the database, return the user object
4155 * @param string $name Username to add
4156 * @param array $params Array of Strings Non-default parameters to save to
4157 * the database as user_* fields:
4158 * - email: The user's email address.
4159 * - email_authenticated: The email authentication timestamp.
4160 * - real_name: The user's real name.
4161 * - options: An associative array of non-default options.
4162 * - token: Random authentication token. Do not set.
4163 * - registration: Registration timestamp. Do not set.
4165 * @return User|null User object, or null if the username already exists.
4167 public static function createNew( $name, $params = [] ) {
4168 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
4169 if ( isset( $params[$field] ) ) {
4170 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
4171 unset( $params[$field] );
4177 $user->setToken(); // init token
4178 if ( isset( $params['options'] ) ) {
4179 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
4180 unset( $params['options'] );
4182 $dbw = wfGetDB( DB_MASTER
);
4184 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4187 'user_name' => $name,
4188 'user_password' => $noPass,
4189 'user_newpassword' => $noPass,
4190 'user_email' => $user->mEmail
,
4191 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
4192 'user_real_name' => $user->mRealName
,
4193 'user_token' => strval( $user->mToken
),
4194 'user_registration' => $dbw->timestamp( $user->mRegistration
),
4195 'user_editcount' => 0,
4196 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4198 foreach ( $params as $name => $value ) {
4199 $fields["user_$name"] = $value;
4202 return $dbw->doAtomicSection( __METHOD__
, function ( IDatabase
$dbw, $fname ) use ( $fields ) {
4203 $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
4204 if ( $dbw->affectedRows() ) {
4205 $newUser = self
::newFromId( $dbw->insertId() );
4206 $newUser->mName
= $fields['user_name'];
4207 $newUser->updateActorId( $dbw );
4208 // Load the user from master to avoid replica lag
4209 $newUser->load( self
::READ_LATEST
);
4218 * Add this existing user object to the database. If the user already
4219 * exists, a fatal status object is returned, and the user object is
4220 * initialised with the data from the database.
4222 * Previously, this function generated a DB error due to a key conflict
4223 * if the user already existed. Many extension callers use this function
4224 * in code along the lines of:
4226 * $user = User::newFromName( $name );
4227 * if ( !$user->isLoggedIn() ) {
4228 * $user->addToDatabase();
4230 * // do something with $user...
4232 * However, this was vulnerable to a race condition (T18020). By
4233 * initialising the user object if the user exists, we aim to support this
4234 * calling sequence as far as possible.
4236 * Note that if the user exists, this function will acquire a write lock,
4237 * so it is still advisable to make the call conditional on isLoggedIn(),
4238 * and to commit the transaction after calling.
4240 * @throws MWException
4243 public function addToDatabase() {
4245 if ( !$this->mToken
) {
4246 $this->setToken(); // init token
4249 if ( !is_string( $this->mName
) ) {
4250 throw new RuntimeException( "User name field is not set." );
4253 $this->mTouched
= $this->newTouchedTimestamp();
4255 $dbw = wfGetDB( DB_MASTER
);
4256 $status = $dbw->doAtomicSection( __METHOD__
, function ( IDatabase
$dbw, $fname ) {
4257 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4258 $dbw->insert( 'user',
4260 'user_name' => $this->mName
,
4261 'user_password' => $noPass,
4262 'user_newpassword' => $noPass,
4263 'user_email' => $this->mEmail
,
4264 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4265 'user_real_name' => $this->mRealName
,
4266 'user_token' => strval( $this->mToken
),
4267 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4268 'user_editcount' => 0,
4269 'user_touched' => $dbw->timestamp( $this->mTouched
),
4273 if ( !$dbw->affectedRows() ) {
4274 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4275 $this->mId
= $dbw->selectField(
4278 [ 'user_name' => $this->mName
],
4280 [ 'LOCK IN SHARE MODE' ]
4283 if ( $this->mId
&& $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4287 throw new MWException( $fname . ": hit a key conflict attempting " .
4288 "to insert user '{$this->mName}' row, but it was not present in select!" );
4290 return Status
::newFatal( 'userexists' );
4292 $this->mId
= $dbw->insertId();
4293 self
::$idCacheByName[$this->mName
] = $this->mId
;
4294 $this->updateActorId( $dbw );
4296 return Status
::newGood();
4298 if ( !$status->isGood() ) {
4302 // Clear instance cache other than user table data and actor, which is already accurate
4303 $this->clearInstanceCache();
4305 $this->saveOptions();
4306 return Status
::newGood();
4310 * Update the actor ID after an insert
4311 * @param IDatabase $dbw Writable database handle
4313 private function updateActorId( IDatabase
$dbw ) {
4314 global $wgActorTableSchemaMigrationStage;
4316 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4319 [ 'actor_user' => $this->mId
, 'actor_name' => $this->mName
],
4322 $this->mActorId
= (int)$dbw->insertId();
4327 * If this user is logged-in and blocked,
4328 * block any IP address they've successfully logged in from.
4329 * @return bool A block was spread
4331 public function spreadAnyEditBlock() {
4332 if ( $this->isLoggedIn() && $this->getBlock() ) {
4333 return $this->spreadBlock();
4340 * If this (non-anonymous) user is blocked,
4341 * block the IP address they've successfully logged in from.
4342 * @return bool A block was spread
4344 protected function spreadBlock() {
4345 wfDebug( __METHOD__
. "()\n" );
4347 if ( $this->mId
== 0 ) {
4351 $userblock = DatabaseBlock
::newFromTarget( $this->getName() );
4352 if ( !$userblock ) {
4356 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4360 * Get whether the user is explicitly blocked from account creation.
4361 * @return bool|AbstractBlock
4363 public function isBlockedFromCreateAccount() {
4364 $this->getBlockedStatus();
4365 if ( $this->mBlock
&& $this->mBlock
->appliesToRight( 'createaccount' ) ) {
4366 return $this->mBlock
;
4369 # T15611: if the IP address the user is trying to create an account from is
4370 # blocked with createaccount disabled, prevent new account creation there even
4371 # when the user is logged in
4372 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4373 $this->mBlockedFromCreateAccount
= DatabaseBlock
::newFromTarget(
4374 null, $this->getRequest()->getIP()
4377 return $this->mBlockedFromCreateAccount
instanceof AbstractBlock
4378 && $this->mBlockedFromCreateAccount
->appliesToRight( 'createaccount' )
4379 ?
$this->mBlockedFromCreateAccount
4384 * Get whether the user is blocked from using Special:Emailuser.
4387 public function isBlockedFromEmailuser() {
4388 $this->getBlockedStatus();
4389 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'sendemail' );
4393 * Get whether the user is blocked from using Special:Upload
4398 public function isBlockedFromUpload() {
4399 $this->getBlockedStatus();
4400 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'upload' );
4404 * Get whether the user is allowed to create an account.
4407 public function isAllowedToCreateAccount() {
4408 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4412 * Get this user's personal page title.
4414 * @return Title User's personal page title
4416 public function getUserPage() {
4417 return Title
::makeTitle( NS_USER
, $this->getName() );
4421 * Get this user's talk page title.
4423 * @return Title User's talk page title
4425 public function getTalkPage() {
4426 $title = $this->getUserPage();
4427 return $title->getTalkPage();
4431 * Determine whether the user is a newbie. Newbies are either
4432 * anonymous IPs, or the most recently created accounts.
4435 public function isNewbie() {
4436 return !$this->isAllowed( 'autoconfirmed' );
4440 * Check to see if the given clear-text password is one of the accepted passwords
4441 * @deprecated since 1.27, use AuthManager instead
4442 * @param string $password User password
4443 * @return bool True if the given password is correct, otherwise False
4445 public function checkPassword( $password ) {
4446 wfDeprecated( __METHOD__
, '1.27' );
4448 $manager = AuthManager
::singleton();
4449 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4450 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4452 'username' => $this->getName(),
4453 'password' => $password,
4456 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4457 switch ( $res->status
) {
4458 case AuthenticationResponse
::PASS
:
4460 case AuthenticationResponse
::FAIL
:
4461 // Hope it's not a PreAuthenticationProvider that failed...
4462 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4463 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4466 throw new BadMethodCallException(
4467 'AuthManager returned a response unsupported by ' . __METHOD__
4473 * Check if the given clear-text password matches the temporary password
4474 * sent by e-mail for password reset operations.
4476 * @deprecated since 1.27, use AuthManager instead
4477 * @param string $plaintext
4478 * @return bool True if matches, false otherwise
4480 public function checkTemporaryPassword( $plaintext ) {
4481 wfDeprecated( __METHOD__
, '1.27' );
4482 // Can't check the temporary password individually.
4483 return $this->checkPassword( $plaintext );
4487 * Initialize (if necessary) and return a session token value
4488 * which can be used in edit forms to show that the user's
4489 * login credentials aren't being hijacked with a foreign form
4493 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4494 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4495 * @return MediaWiki\Session\Token The new edit token
4497 public function getEditTokenObject( $salt = '', $request = null ) {
4498 if ( $this->isAnon() ) {
4499 return new LoggedOutEditToken();
4503 $request = $this->getRequest();
4505 return $request->getSession()->getToken( $salt );
4509 * Initialize (if necessary) and return a session token value
4510 * which can be used in edit forms to show that the user's
4511 * login credentials aren't being hijacked with a foreign form
4514 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4517 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4518 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4519 * @return string The new edit token
4521 public function getEditToken( $salt = '', $request = null ) {
4522 return $this->getEditTokenObject( $salt, $request )->toString();
4526 * Check given value against the token value stored in the session.
4527 * A match should confirm that the form was submitted from the
4528 * user's own login session, not a form submission from a third-party
4531 * @param string $val Input value to compare
4532 * @param string|array $salt Optional function-specific data for hashing
4533 * @param WebRequest|null $request Object to use or null to use $wgRequest
4534 * @param int|null $maxage Fail tokens older than this, in seconds
4535 * @return bool Whether the token matches
4537 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4538 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4542 * Check given value against the token value stored in the session,
4543 * ignoring the suffix.
4545 * @param string $val Input value to compare
4546 * @param string|array $salt Optional function-specific data for hashing
4547 * @param WebRequest|null $request Object to use or null to use $wgRequest
4548 * @param int|null $maxage Fail tokens older than this, in seconds
4549 * @return bool Whether the token matches
4551 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4552 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4553 return $this->matchEditToken( $val, $salt, $request, $maxage );
4557 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4558 * mail to the user's given address.
4560 * @param string $type Message to send, either "created", "changed" or "set"
4563 public function sendConfirmationMail( $type = 'created' ) {
4565 $expiration = null; // gets passed-by-ref and defined in next line.
4566 $token = $this->confirmationToken( $expiration );
4567 $url = $this->confirmationTokenUrl( $token );
4568 $invalidateURL = $this->invalidationTokenUrl( $token );
4569 $this->saveSettings();
4571 if ( $type == 'created' ||
$type === false ) {
4572 $message = 'confirmemail_body';
4574 } elseif ( $type === true ) {
4575 $message = 'confirmemail_body_changed';
4578 // Messages: confirmemail_body_changed, confirmemail_body_set
4579 $message = 'confirmemail_body_' . $type;
4583 'subject' => wfMessage( 'confirmemail_subject' )->text(),
4584 'body' => wfMessage( $message,
4585 $this->getRequest()->getIP(),
4588 $wgLang->userTimeAndDate( $expiration, $this ),
4590 $wgLang->userDate( $expiration, $this ),
4591 $wgLang->userTime( $expiration, $this ) )->text(),
4597 'ip' => $this->getRequest()->getIP(),
4598 'confirmURL' => $url,
4599 'invalidateURL' => $invalidateURL,
4600 'expiration' => $expiration
4603 Hooks
::run( 'UserSendConfirmationMail', [ $this, &$mail, $info ] );
4604 return $this->sendMail( $mail['subject'], $mail['body'], $mail['from'], $mail['replyTo'] );
4608 * Send an e-mail to this user's account. Does not check for
4609 * confirmed status or validity.
4611 * @param string $subject Message subject
4612 * @param string $body Message body
4613 * @param User|null $from Optional sending user; if unspecified, default
4614 * $wgPasswordSender will be used.
4615 * @param MailAddress|null $replyto Reply-To address
4618 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4619 global $wgPasswordSender;
4621 if ( $from instanceof User
) {
4622 $sender = MailAddress
::newFromUser( $from );
4624 $sender = new MailAddress( $wgPasswordSender,
4625 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4627 $to = MailAddress
::newFromUser( $this );
4629 return UserMailer
::send( $to, $sender, $subject, $body, [
4630 'replyTo' => $replyto,
4635 * Generate, store, and return a new e-mail confirmation code.
4636 * A hash (unsalted, since it's used as a key) is stored.
4638 * @note Call saveSettings() after calling this function to commit
4639 * this change to the database.
4641 * @param string &$expiration Accepts the expiration time
4642 * @return string New token
4644 protected function confirmationToken( &$expiration ) {
4645 global $wgUserEmailConfirmationTokenExpiry;
4647 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4648 $expiration = wfTimestamp( TS_MW
, $expires );
4650 $token = MWCryptRand
::generateHex( 32 );
4651 $hash = md5( $token );
4652 $this->mEmailToken
= $hash;
4653 $this->mEmailTokenExpires
= $expiration;
4658 * Return a URL the user can use to confirm their email address.
4659 * @param string $token Accepts the email confirmation token
4660 * @return string New token URL
4662 protected function confirmationTokenUrl( $token ) {
4663 return $this->getTokenUrl( 'ConfirmEmail', $token );
4667 * Return a URL the user can use to invalidate their email address.
4668 * @param string $token Accepts the email confirmation token
4669 * @return string New token URL
4671 protected function invalidationTokenUrl( $token ) {
4672 return $this->getTokenUrl( 'InvalidateEmail', $token );
4676 * Internal function to format the e-mail validation/invalidation URLs.
4677 * This uses a quickie hack to use the
4678 * hardcoded English names of the Special: pages, for ASCII safety.
4680 * @note Since these URLs get dropped directly into emails, using the
4681 * short English names avoids insanely long URL-encoded links, which
4682 * also sometimes can get corrupted in some browsers/mailers
4683 * (T8957 with Gmail and Internet Explorer).
4685 * @param string $page Special page
4686 * @param string $token
4687 * @return string Formatted URL
4689 protected function getTokenUrl( $page, $token ) {
4690 // Hack to bypass localization of 'Special:'
4691 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4692 return $title->getCanonicalURL();
4696 * Mark the e-mail address confirmed.
4698 * @note Call saveSettings() after calling this function to commit the change.
4702 public function confirmEmail() {
4703 // Check if it's already confirmed, so we don't touch the database
4704 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4705 if ( !$this->isEmailConfirmed() ) {
4706 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4707 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4713 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4714 * address if it was already confirmed.
4716 * @note Call saveSettings() after calling this function to commit the change.
4717 * @return bool Returns true
4719 public function invalidateEmail() {
4721 $this->mEmailToken
= null;
4722 $this->mEmailTokenExpires
= null;
4723 $this->setEmailAuthenticationTimestamp( null );
4725 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4730 * Set the e-mail authentication timestamp.
4731 * @param string $timestamp TS_MW timestamp
4733 public function setEmailAuthenticationTimestamp( $timestamp ) {
4735 $this->mEmailAuthenticated
= $timestamp;
4736 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4740 * Is this user allowed to send e-mails within limits of current
4741 * site configuration?
4744 public function canSendEmail() {
4745 global $wgEnableEmail, $wgEnableUserEmail;
4746 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4749 $canSend = $this->isEmailConfirmed();
4750 // Avoid PHP 7.1 warning of passing $this by reference
4752 Hooks
::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
4757 * Is this user allowed to receive e-mails within limits of current
4758 * site configuration?
4761 public function canReceiveEmail() {
4762 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4766 * Is this user's e-mail address valid-looking and confirmed within
4767 * limits of the current site configuration?
4769 * @note If $wgEmailAuthentication is on, this may require the user to have
4770 * confirmed their address by returning a code or using a password
4771 * sent to the address from the wiki.
4775 public function isEmailConfirmed() {
4776 global $wgEmailAuthentication;
4778 // Avoid PHP 7.1 warning of passing $this by reference
4781 if ( Hooks
::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
4782 if ( $this->isAnon() ) {
4785 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4788 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4798 * Check whether there is an outstanding request for e-mail confirmation.
4801 public function isEmailConfirmationPending() {
4802 global $wgEmailAuthentication;
4803 return $wgEmailAuthentication &&
4804 !$this->isEmailConfirmed() &&
4805 $this->mEmailToken
&&
4806 $this->mEmailTokenExpires
> wfTimestamp();
4810 * Get the timestamp of account creation.
4812 * @return string|bool|null Timestamp of account creation, false for
4813 * non-existent/anonymous user accounts, or null if existing account
4814 * but information is not in database.
4816 public function getRegistration() {
4817 if ( $this->isAnon() ) {
4821 return $this->mRegistration
;
4825 * Get the timestamp of the first edit
4827 * @return string|bool Timestamp of first edit, or false for
4828 * non-existent/anonymous user accounts.
4830 public function getFirstEditTimestamp() {
4831 return $this->getEditTimestamp( true );
4835 * Get the timestamp of the latest edit
4838 * @return string|bool Timestamp of first edit, or false for
4839 * non-existent/anonymous user accounts.
4841 public function getLatestEditTimestamp() {
4842 return $this->getEditTimestamp( false );
4846 * Get the timestamp of the first or latest edit
4848 * @param bool $first True for the first edit, false for the latest one
4849 * @return string|bool Timestamp of first or latest edit, or false for
4850 * non-existent/anonymous user accounts.
4852 private function getEditTimestamp( $first ) {
4853 if ( $this->getId() == 0 ) {
4854 return false; // anons
4856 $dbr = wfGetDB( DB_REPLICA
);
4857 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
4858 $tsField = isset( $actorWhere['tables']['temp_rev_user'] )
4859 ?
'revactor_timestamp' : 'rev_timestamp';
4860 $sortOrder = $first ?
'ASC' : 'DESC';
4861 $time = $dbr->selectField(
4862 [ 'revision' ] +
$actorWhere['tables'],
4864 [ $actorWhere['conds'] ],
4866 [ 'ORDER BY' => "$tsField $sortOrder" ],
4867 $actorWhere['joins']
4870 return false; // no edits
4872 return wfTimestamp( TS_MW
, $time );
4876 * Get the permissions associated with a given list of groups
4878 * @param array $groups Array of Strings List of internal group names
4879 * @return array Array of Strings List of permission key names for given groups combined
4881 public static function getGroupPermissions( $groups ) {
4882 global $wgGroupPermissions, $wgRevokePermissions;
4884 // grant every granted permission first
4885 foreach ( $groups as $group ) {
4886 if ( isset( $wgGroupPermissions[$group] ) ) {
4887 $rights = array_merge( $rights,
4888 // array_filter removes empty items
4889 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4892 // now revoke the revoked permissions
4893 foreach ( $groups as $group ) {
4894 if ( isset( $wgRevokePermissions[$group] ) ) {
4895 $rights = array_diff( $rights,
4896 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4899 return array_unique( $rights );
4903 * Get all the groups who have a given permission
4905 * @param string $role Role to check
4906 * @return array Array of Strings List of internal group names with the given permission
4908 public static function getGroupsWithPermission( $role ) {
4909 global $wgGroupPermissions;
4910 $allowedGroups = [];
4911 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4912 if ( self
::groupHasPermission( $group, $role ) ) {
4913 $allowedGroups[] = $group;
4916 return $allowedGroups;
4920 * Check, if the given group has the given permission
4922 * If you're wanting to check whether all users have a permission, use
4923 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4927 * @param string $group Group to check
4928 * @param string $role Role to check
4931 public static function groupHasPermission( $group, $role ) {
4932 global $wgGroupPermissions, $wgRevokePermissions;
4933 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4934 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4938 * Check if all users may be assumed to have the given permission
4940 * We generally assume so if the right is granted to '*' and isn't revoked
4941 * on any group. It doesn't attempt to take grants or other extension
4942 * limitations on rights into account in the general case, though, as that
4943 * would require it to always return false and defeat the purpose.
4944 * Specifically, session-based rights restrictions (such as OAuth or bot
4945 * passwords) are applied based on the current session.
4948 * @param string $right Right to check
4951 public static function isEveryoneAllowed( $right ) {
4952 global $wgGroupPermissions, $wgRevokePermissions;
4955 // Use the cached results, except in unit tests which rely on
4956 // being able change the permission mid-request
4957 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
4958 return $cache[$right];
4961 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
4962 $cache[$right] = false;
4966 // If it's revoked anywhere, then everyone doesn't have it
4967 foreach ( $wgRevokePermissions as $rights ) {
4968 if ( isset( $rights[$right] ) && $rights[$right] ) {
4969 $cache[$right] = false;
4974 // Remove any rights that aren't allowed to the global-session user,
4975 // unless there are no sessions for this endpoint.
4976 if ( !defined( 'MW_NO_SESSION' ) ) {
4977 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
4978 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
4979 $cache[$right] = false;
4984 // Allow extensions to say false
4985 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
4986 $cache[$right] = false;
4990 $cache[$right] = true;
4995 * Return the set of defined explicit groups.
4996 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4997 * are not included, as they are defined automatically, not in the database.
4998 * @return array Array of internal group names
5000 public static function getAllGroups() {
5001 global $wgGroupPermissions, $wgRevokePermissions;
5002 return array_values( array_diff(
5003 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
5004 self
::getImplicitGroups()
5009 * Get a list of all available permissions.
5010 * @return string[] Array of permission names
5012 public static function getAllRights() {
5013 if ( self
::$mAllRights === false ) {
5014 global $wgAvailableRights;
5015 if ( count( $wgAvailableRights ) ) {
5016 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
5018 self
::$mAllRights = self
::$mCoreRights;
5020 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
5022 return self
::$mAllRights;
5026 * Get a list of implicit groups
5027 * TODO: Should we deprecate this? It's trivial, but we don't want to encourage use of globals.
5029 * @return array Array of Strings Array of internal group names
5031 public static function getImplicitGroups() {
5032 global $wgImplicitGroups;
5033 return $wgImplicitGroups;
5037 * Returns an array of the groups that a particular group can add/remove.
5039 * @param string $group The group to check for whether it can add/remove
5040 * @return array [ 'add' => [ addablegroups ],
5041 * 'remove' => [ removablegroups ],
5042 * 'add-self' => [ addablegroups to self ],
5043 * 'remove-self' => [ removable groups from self ] ]
5045 public static function changeableByGroup( $group ) {
5046 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
5055 if ( empty( $wgAddGroups[$group] ) ) {
5056 // Don't add anything to $groups
5057 } elseif ( $wgAddGroups[$group] === true ) {
5058 // You get everything
5059 $groups['add'] = self
::getAllGroups();
5060 } elseif ( is_array( $wgAddGroups[$group] ) ) {
5061 $groups['add'] = $wgAddGroups[$group];
5064 // Same thing for remove
5065 if ( empty( $wgRemoveGroups[$group] ) ) {
5067 } elseif ( $wgRemoveGroups[$group] === true ) {
5068 $groups['remove'] = self
::getAllGroups();
5069 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
5070 $groups['remove'] = $wgRemoveGroups[$group];
5073 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
5074 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
5075 foreach ( $wgGroupsAddToSelf as $key => $value ) {
5076 if ( is_int( $key ) ) {
5077 $wgGroupsAddToSelf['user'][] = $value;
5082 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
5083 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
5084 if ( is_int( $key ) ) {
5085 $wgGroupsRemoveFromSelf['user'][] = $value;
5090 // Now figure out what groups the user can add to him/herself
5091 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
5093 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
5094 // No idea WHY this would be used, but it's there
5095 $groups['add-self'] = self
::getAllGroups();
5096 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
5097 $groups['add-self'] = $wgGroupsAddToSelf[$group];
5100 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
5102 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
5103 $groups['remove-self'] = self
::getAllGroups();
5104 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
5105 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
5112 * Returns an array of groups that this user can add and remove
5113 * @return array [ 'add' => [ addablegroups ],
5114 * 'remove' => [ removablegroups ],
5115 * 'add-self' => [ addablegroups to self ],
5116 * 'remove-self' => [ removable groups from self ] ]
5118 public function changeableGroups() {
5119 if ( $this->isAllowed( 'userrights' ) ) {
5120 // This group gives the right to modify everything (reverse-
5121 // compatibility with old "userrights lets you change
5123 // Using array_merge to make the groups reindexed
5124 $all = array_merge( self
::getAllGroups() );
5133 // Okay, it's not so simple, we will have to go through the arrays
5140 $addergroups = $this->getEffectiveGroups();
5142 foreach ( $addergroups as $addergroup ) {
5143 $groups = array_merge_recursive(
5144 $groups, $this->changeableByGroup( $addergroup )
5146 $groups['add'] = array_unique( $groups['add'] );
5147 $groups['remove'] = array_unique( $groups['remove'] );
5148 $groups['add-self'] = array_unique( $groups['add-self'] );
5149 $groups['remove-self'] = array_unique( $groups['remove-self'] );
5155 * Schedule a deferred update to update the user's edit count
5157 public function incEditCount() {
5158 if ( $this->isAnon() ) {
5162 DeferredUpdates
::addUpdate(
5163 new UserEditCountUpdate( $this, 1 ),
5164 DeferredUpdates
::POSTSEND
5169 * This method should not be called outside User/UserEditCountUpdate
5173 public function setEditCountInternal( $count ) {
5174 $this->mEditCount
= $count;
5178 * Initialize user_editcount from data out of the revision table
5180 * This method should not be called outside User/UserEditCountUpdate
5182 * @return int Number of edits
5184 public function initEditCountInternal() {
5185 // Pull from a replica DB to be less cruel to servers
5186 // Accuracy isn't the point anyway here
5187 $dbr = wfGetDB( DB_REPLICA
);
5188 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5189 $count = (int)$dbr->selectField(
5190 [ 'revision' ] +
$actorWhere['tables'],
5192 [ $actorWhere['conds'] ],
5195 $actorWhere['joins']
5198 $dbw = wfGetDB( DB_MASTER
);
5201 [ 'user_editcount' => $count ],
5203 'user_id' => $this->getId(),
5204 'user_editcount IS NULL OR user_editcount < ' . (int)$count
5213 * Get the description of a given right
5216 * @param string $right Right to query
5217 * @return string Localized description of the right
5219 public static function getRightDescription( $right ) {
5220 $key = "right-$right";
5221 $msg = wfMessage( $key );
5222 return $msg->isDisabled() ?
$right : $msg->text();
5226 * Get the name of a given grant
5229 * @param string $grant Grant to query
5230 * @return string Localized name of the grant
5232 public static function getGrantName( $grant ) {
5233 $key = "grant-$grant";
5234 $msg = wfMessage( $key );
5235 return $msg->isDisabled() ?
$grant : $msg->text();
5239 * Add a newuser log entry for this user.
5240 * Before 1.19 the return value was always true.
5242 * @deprecated since 1.27, AuthManager handles logging
5243 * @param string|bool $action Account creation type.
5244 * - String, one of the following values:
5245 * - 'create' for an anonymous user creating an account for himself.
5246 * This will force the action's performer to be the created user itself,
5247 * no matter the value of $wgUser
5248 * - 'create2' for a logged in user creating an account for someone else
5249 * - 'byemail' when the created user will receive its password by e-mail
5250 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5251 * - Boolean means whether the account was created by e-mail (deprecated):
5252 * - true will be converted to 'byemail'
5253 * - false will be converted to 'create' if this object is the same as
5254 * $wgUser and to 'create2' otherwise
5255 * @param string $reason User supplied reason
5258 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5259 return true; // disabled
5263 * Add an autocreate newuser log entry for this user
5264 * Used by things like CentralAuth and perhaps other authplugins.
5265 * Consider calling addNewUserLogEntry() directly instead.
5267 * @deprecated since 1.27, AuthManager handles logging
5270 public function addNewUserLogEntryAutoCreate() {
5271 $this->addNewUserLogEntry( 'autocreate' );
5277 * Load the user options either from cache, the database or an array
5279 * @param array|null $data Rows for the current user out of the user_properties table
5281 protected function loadOptions( $data = null ) {
5284 if ( $this->mOptionsLoaded
) {
5288 $this->mOptions
= self
::getDefaultOptions();
5290 if ( !$this->getId() ) {
5291 // For unlogged-in users, load language/variant options from request.
5292 // There's no need to do it for logged-in users: they can set preferences,
5293 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5294 // so don't override user's choice (especially when the user chooses site default).
5295 $variant = MediaWikiServices
::getInstance()->getContentLanguage()->getDefaultVariant();
5296 $this->mOptions
['variant'] = $variant;
5297 $this->mOptions
['language'] = $variant;
5298 $this->mOptionsLoaded
= true;
5302 // Maybe load from the object
5303 if ( !is_null( $this->mOptionOverrides
) ) {
5304 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5305 foreach ( $this->mOptionOverrides
as $key => $value ) {
5306 $this->mOptions
[$key] = $value;
5309 if ( !is_array( $data ) ) {
5310 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5311 // Load from database
5312 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5313 ?
wfGetDB( DB_MASTER
)
5314 : wfGetDB( DB_REPLICA
);
5316 $res = $dbr->select(
5318 [ 'up_property', 'up_value' ],
5319 [ 'up_user' => $this->getId() ],
5323 $this->mOptionOverrides
= [];
5325 foreach ( $res as $row ) {
5326 // Convert '0' to 0. PHP's boolean conversion considers them both
5327 // false, but e.g. JavaScript considers the former as true.
5328 // @todo: T54542 Somehow determine the desired type (string/int/bool)
5329 // and convert all values here.
5330 if ( $row->up_value
=== '0' ) {
5333 $data[$row->up_property
] = $row->up_value
;
5337 foreach ( $data as $property => $value ) {
5338 $this->mOptionOverrides
[$property] = $value;
5339 $this->mOptions
[$property] = $value;
5343 // Replace deprecated language codes
5344 $this->mOptions
['language'] = LanguageCode
::replaceDeprecatedCodes(
5345 $this->mOptions
['language']
5348 $this->mOptionsLoaded
= true;
5350 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5354 * Saves the non-default options for this user, as previously set e.g. via
5355 * setOption(), in the database's "user_properties" (preferences) table.
5356 * Usually used via saveSettings().
5358 protected function saveOptions() {
5359 $this->loadOptions();
5361 // Not using getOptions(), to keep hidden preferences in database
5362 $saveOptions = $this->mOptions
;
5364 // Allow hooks to abort, for instance to save to a global profile.
5365 // Reset options to default state before saving.
5366 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5370 $userId = $this->getId();
5372 $insert_rows = []; // all the new preference rows
5373 foreach ( $saveOptions as $key => $value ) {
5374 // Don't bother storing default values
5375 $defaultOption = self
::getDefaultOption( $key );
5376 if ( ( $defaultOption === null && $value !== false && $value !== null )
5377 ||
$value != $defaultOption
5380 'up_user' => $userId,
5381 'up_property' => $key,
5382 'up_value' => $value,
5387 $dbw = wfGetDB( DB_MASTER
);
5389 $res = $dbw->select( 'user_properties',
5390 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5392 // Find prior rows that need to be removed or updated. These rows will
5393 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5395 foreach ( $res as $row ) {
5396 if ( !isset( $saveOptions[$row->up_property
] )
5397 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5399 $keysDelete[] = $row->up_property
;
5403 if ( count( $keysDelete ) ) {
5404 // Do the DELETE by PRIMARY KEY for prior rows.
5405 // In the past a very large portion of calls to this function are for setting
5406 // 'rememberpassword' for new accounts (a preference that has since been removed).
5407 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5408 // caused gap locks on [max user ID,+infinity) which caused high contention since
5409 // updates would pile up on each other as they are for higher (newer) user IDs.
5410 // It might not be necessary these days, but it shouldn't hurt either.
5411 $dbw->delete( 'user_properties',
5412 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5414 // Insert the new preference rows
5415 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5419 * Return the list of user fields that should be selected to create
5420 * a new user object.
5421 * @deprecated since 1.31, use self::getQueryInfo() instead.
5424 public static function selectFields() {
5425 wfDeprecated( __METHOD__
, '1.31' );
5433 'user_email_authenticated',
5435 'user_email_token_expires',
5436 'user_registration',
5442 * Return the tables, fields, and join conditions to be selected to create
5443 * a new user object.
5445 * @return array With three keys:
5446 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
5447 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
5448 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
5450 public static function getQueryInfo() {
5451 global $wgActorTableSchemaMigrationStage;
5454 'tables' => [ 'user' ],
5462 'user_email_authenticated',
5464 'user_email_token_expires',
5465 'user_registration',
5471 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
5472 // but it does little harm and might be needed for write callers loading a User.
5473 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
5474 $ret['tables']['user_actor'] = 'actor';
5475 $ret['fields'][] = 'user_actor.actor_id';
5476 $ret['joins']['user_actor'] = [
5477 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) ?
'JOIN' : 'LEFT JOIN',
5478 [ 'user_actor.actor_user = user_id' ]
5486 * Factory function for fatal permission-denied errors
5489 * @param string $permission User right required
5492 static function newFatalPermissionDeniedStatus( $permission ) {
5496 foreach ( self
::getGroupsWithPermission( $permission ) as $group ) {
5497 $groups[] = UserGroupMembership
::getLink( $group, RequestContext
::getMain(), 'wiki' );
5501 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5504 return Status
::newFatal( 'badaccess-group0' );
5508 * Get a new instance of this user that was loaded from the master via a locking read
5510 * Use this instead of the main context User when updating that user. This avoids races
5511 * where that user was loaded from a replica DB or even the master but without proper locks.
5513 * @return User|null Returns null if the user was not found in the DB
5516 public function getInstanceForUpdate() {
5517 if ( !$this->getId() ) {
5518 return null; // anon
5521 $user = self
::newFromId( $this->getId() );
5522 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5530 * Checks if two user objects point to the same user.
5532 * @since 1.25 ; takes a UserIdentity instead of a User since 1.32
5533 * @param UserIdentity $user
5536 public function equals( UserIdentity
$user ) {
5537 // XXX it's not clear whether central ID providers are supposed to obey this
5538 return $this->getName() === $user->getName();
5542 * Checks if usertalk is allowed
5546 public function isAllowUsertalk() {
5547 return $this->mAllowUsertalk
;