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\MediaWikiServices
;
24 use MediaWiki\Session\SessionManager
;
25 use MediaWiki\Session\Token
;
26 use MediaWiki\Auth\AuthManager
;
27 use MediaWiki\Auth\AuthenticationResponse
;
28 use MediaWiki\Auth\AuthenticationRequest
;
29 use MediaWiki\User\UserIdentity
;
30 use MediaWiki\Logger\LoggerFactory
;
31 use Wikimedia\Assert\Assert
;
33 use Wikimedia\ScopedCallback
;
34 use Wikimedia\Rdbms\Database
;
35 use Wikimedia\Rdbms\DBExpectedError
;
36 use Wikimedia\Rdbms\IDatabase
;
39 * The User object encapsulates all of the user-specific settings (user_id,
40 * name, rights, email address, options, last login time). Client
41 * classes use the getXXX() functions to access these fields. These functions
42 * do all the work of determining whether the user is logged in,
43 * whether the requested option can be satisfied from cookies or
44 * whether a database query is needed. Most of the settings needed
45 * for rendering normal pages are set in the cookie to minimize use
48 class User
implements IDBAccessObject
, UserIdentity
{
50 * @const int Number of characters in user_token field.
52 const TOKEN_LENGTH
= 32;
55 * @const string An invalid value for user_token
57 const INVALID_TOKEN
= '*** INVALID ***';
60 * @const int Serialized record version.
65 * Exclude user options that are set to their default value.
68 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
73 const CHECK_USER_RIGHTS
= true;
78 const IGNORE_USER_RIGHTS
= false;
81 * Array of Strings List of member variables which are saved to the
82 * shared cache (memcached). Any operation which changes the
83 * corresponding database fields must call a cache-clearing function.
86 protected static $mCacheVars = [
94 'mEmailAuthenticated',
101 // user_properties table
108 * Array of Strings Core rights.
109 * Each of these should have a corresponding message of the form
113 protected static $mCoreRights = [
161 'move-categorypages',
162 'move-rootuserpages',
166 'override-export-depth',
188 'userrights-interwiki',
196 * String Cached results of getAllRights()
198 protected static $mAllRights = false;
200 /** Cache variables */
213 /** @var string TS_MW timestamp from the DB */
215 /** @var string TS_MW timestamp from cache */
216 protected $mQuickTouched;
220 public $mEmailAuthenticated;
222 protected $mEmailToken;
224 protected $mEmailTokenExpires;
226 protected $mRegistration;
228 protected $mEditCount;
229 /** @var UserGroupMembership[] Associative array of (group name => UserGroupMembership object) */
230 protected $mGroupMemberships;
232 protected $mOptionOverrides;
236 * Bool Whether the cache variables have been loaded.
239 public $mOptionsLoaded;
242 * Array with already loaded items or true if all items have been loaded.
244 protected $mLoadedItems = [];
248 * String Initialization data source if mLoadedItems!==true. May be one of:
249 * - 'defaults' anonymous user initialised from class defaults
250 * - 'name' initialise from mName
251 * - 'id' initialise from mId
252 * - 'actor' initialise from mActorId
253 * - 'session' log in from session if possible
255 * Use the User::newFrom*() family of functions to set this.
260 * Lazy-initialized variables, invalidated with clearInstanceCache
264 protected $mDatePreference;
272 protected $mBlockreason;
274 protected $mEffectiveGroups;
276 protected $mImplicitGroups;
278 protected $mFormerGroups;
280 protected $mGlobalBlock;
288 /** @var WebRequest */
295 protected $mAllowUsertalk;
298 private $mBlockedFromCreateAccount = false;
300 /** @var int User::READ_* constant bitfield used to load data */
301 protected $queryFlagsUsed = self
::READ_NORMAL
;
303 public static $idCacheByName = [];
306 * Lightweight constructor for an anonymous user.
307 * Use the User::newFrom* factory functions for other kinds of users.
311 * @see newFromActorId()
312 * @see newFromConfirmationCode()
313 * @see newFromSession()
316 public function __construct() {
317 $this->clearInstanceCache( 'defaults' );
323 public function __toString() {
324 return (string)$this->getName();
328 * Test if it's safe to load this User object.
330 * You should typically check this before using $wgUser or
331 * RequestContext::getUser in a method that might be called before the
332 * system has been fully initialized. If the object is unsafe, you should
333 * use an anonymous user:
335 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
341 public function isSafeToLoad() {
342 global $wgFullyInitialised;
344 // The user is safe to load if:
345 // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
346 // * mLoadedItems === true (already loaded)
347 // * mFrom !== 'session' (sessions not involved at all)
349 return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
350 $this->mLoadedItems
=== true ||
$this->mFrom
!== 'session';
354 * Load the user table data for this object from the source given by mFrom.
356 * @param int $flags User::READ_* constant bitfield
358 public function load( $flags = self
::READ_NORMAL
) {
359 global $wgFullyInitialised;
361 if ( $this->mLoadedItems
=== true ) {
365 // Set it now to avoid infinite recursion in accessors
366 $oldLoadedItems = $this->mLoadedItems
;
367 $this->mLoadedItems
= true;
368 $this->queryFlagsUsed
= $flags;
370 // If this is called too early, things are likely to break.
371 if ( !$wgFullyInitialised && $this->mFrom
=== 'session' ) {
372 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
373 ->warning( 'User::loadFromSession called before the end of Setup.php', [
374 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
376 $this->loadDefaults();
377 $this->mLoadedItems
= $oldLoadedItems;
381 switch ( $this->mFrom
) {
383 $this->loadDefaults();
386 // Make sure this thread sees its own changes
387 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
388 if ( $lb->hasOrMadeRecentMasterChanges() ) {
389 $flags |
= self
::READ_LATEST
;
390 $this->queryFlagsUsed
= $flags;
393 $this->mId
= self
::idFromName( $this->mName
, $flags );
395 // Nonexistent user placeholder object
396 $this->loadDefaults( $this->mName
);
398 $this->loadFromId( $flags );
402 // Make sure this thread sees its own changes, if the ID isn't 0
403 if ( $this->mId
!= 0 ) {
404 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
405 if ( $lb->hasOrMadeRecentMasterChanges() ) {
406 $flags |
= self
::READ_LATEST
;
407 $this->queryFlagsUsed
= $flags;
411 $this->loadFromId( $flags );
414 // Make sure this thread sees its own changes
415 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
416 if ( $lb->hasOrMadeRecentMasterChanges() ) {
417 $flags |
= self
::READ_LATEST
;
418 $this->queryFlagsUsed
= $flags;
421 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
422 $row = wfGetDB( $index )->selectRow(
424 [ 'actor_user', 'actor_name' ],
425 [ 'actor_id' => $this->mActorId
],
432 $this->loadDefaults();
433 } elseif ( $row->actor_user
) {
434 $this->mId
= $row->actor_user
;
435 $this->loadFromId( $flags );
437 $this->loadDefaults( $row->actor_name
);
441 if ( !$this->loadFromSession() ) {
442 // Loading from session failed. Load defaults.
443 $this->loadDefaults();
445 Hooks
::run( 'UserLoadAfterLoadFromSession', [ $this ] );
448 throw new UnexpectedValueException(
449 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
454 * Load user table data, given mId has already been set.
455 * @param int $flags User::READ_* constant bitfield
456 * @return bool False if the ID does not exist, true otherwise
458 public function loadFromId( $flags = self
::READ_NORMAL
) {
459 if ( $this->mId
== 0 ) {
460 // Anonymous users are not in the database (don't need cache)
461 $this->loadDefaults();
465 // Try cache (unless this needs data from the master DB).
466 // NOTE: if this thread called saveSettings(), the cache was cleared.
467 $latest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
469 if ( !$this->loadFromDatabase( $flags ) ) {
470 // Can't load from ID
474 $this->loadFromCache();
477 $this->mLoadedItems
= true;
478 $this->queryFlagsUsed
= $flags;
485 * @param string $wikiId
488 public static function purge( $wikiId, $userId ) {
489 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
490 $key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
491 $cache->delete( $key );
496 * @param WANObjectCache $cache
499 protected function getCacheKey( WANObjectCache
$cache ) {
500 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
502 return $cache->makeGlobalKey( 'user', 'id', $lbFactory->getLocalDomainID(), $this->mId
);
506 * @param WANObjectCache $cache
510 public function getMutableCacheKeys( WANObjectCache
$cache ) {
511 $id = $this->getId();
513 return $id ?
[ $this->getCacheKey( $cache ) ] : [];
517 * Load user data from shared cache, given mId has already been set.
522 protected function loadFromCache() {
523 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
524 $data = $cache->getWithSetCallback(
525 $this->getCacheKey( $cache ),
527 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
528 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
529 wfDebug( "User: cache miss for user {$this->mId}\n" );
531 $this->loadFromDatabase( self
::READ_NORMAL
);
533 $this->loadOptions();
536 foreach ( self
::$mCacheVars as $name ) {
537 $data[$name] = $this->$name;
540 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->mTouched
), $ttl );
542 // if a user group membership is about to expire, the cache needs to
543 // expire at that time (T163691)
544 foreach ( $this->mGroupMemberships
as $ugm ) {
545 if ( $ugm->getExpiry() ) {
546 $secondsUntilExpiry = wfTimestamp( TS_UNIX
, $ugm->getExpiry() ) - time();
547 if ( $secondsUntilExpiry > 0 && $secondsUntilExpiry < $ttl ) {
548 $ttl = $secondsUntilExpiry;
555 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'version' => self
::VERSION
]
558 // Restore from cache
559 foreach ( self
::$mCacheVars as $name ) {
560 $this->$name = $data[$name];
566 /** @name newFrom*() static factory methods */
570 * Static factory method for creation from username.
572 * This is slightly less efficient than newFromId(), so use newFromId() if
573 * you have both an ID and a name handy.
575 * @param string $name Username, validated by Title::newFromText()
576 * @param string|bool $validate Validate username. Takes the same parameters as
577 * User::getCanonicalName(), except that true is accepted as an alias
578 * for 'valid', for BC.
580 * @return User|bool User object, or false if the username is invalid
581 * (e.g. if it contains illegal characters or is an IP address). If the
582 * username is not present in the database, the result will be a user object
583 * with a name, zero user ID and default settings.
585 public static function newFromName( $name, $validate = 'valid' ) {
586 if ( $validate === true ) {
589 $name = self
::getCanonicalName( $name, $validate );
590 if ( $name === false ) {
594 // Create unloaded user object
598 $u->setItemLoaded( 'name' );
604 * Static factory method for creation from a given user ID.
606 * @param int $id Valid user ID
607 * @return User The corresponding User object
609 public static function newFromId( $id ) {
613 $u->setItemLoaded( 'id' );
618 * Static factory method for creation from a given actor ID.
621 * @param int $id Valid actor ID
622 * @return User The corresponding User object
624 public static function newFromActorId( $id ) {
625 global $wgActorTableSchemaMigrationStage;
627 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
628 // but it does little harm and might be needed for write callers loading a User.
629 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) ) {
630 throw new BadMethodCallException(
631 'Cannot use ' . __METHOD__
632 . ' when $wgActorTableSchemaMigrationStage lacks SCHEMA_COMPAT_NEW'
639 $u->setItemLoaded( 'actor' );
644 * Returns a User object corresponding to the given UserIdentity.
648 * @param UserIdentity $identity
652 public static function newFromIdentity( UserIdentity
$identity ) {
653 if ( $identity instanceof User
) {
657 return self
::newFromAnyId(
658 $identity->getId() === 0 ?
null : $identity->getId(),
659 $identity->getName() === '' ?
null : $identity->getName(),
660 $identity->getActorId() === 0 ?
null : $identity->getActorId()
665 * Static factory method for creation from an ID, name, and/or actor ID
667 * This does not check that the ID, name, and actor ID all correspond to
671 * @param int|null $userId User ID, if known
672 * @param string|null $userName User name, if known
673 * @param int|null $actorId Actor ID, if known
676 public static function newFromAnyId( $userId, $userName, $actorId ) {
677 global $wgActorTableSchemaMigrationStage;
680 $user->mFrom
= 'defaults';
682 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
683 // but it does little harm and might be needed for write callers loading a User.
684 if ( ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) && $actorId !== null ) {
685 $user->mActorId
= (int)$actorId;
686 if ( $user->mActorId
!== 0 ) {
687 $user->mFrom
= 'actor';
689 $user->setItemLoaded( 'actor' );
692 if ( $userName !== null && $userName !== '' ) {
693 $user->mName
= $userName;
694 $user->mFrom
= 'name';
695 $user->setItemLoaded( 'name' );
698 if ( $userId !== null ) {
699 $user->mId
= (int)$userId;
700 if ( $user->mId
!== 0 ) {
703 $user->setItemLoaded( 'id' );
706 if ( $user->mFrom
=== 'defaults' ) {
707 throw new InvalidArgumentException(
708 'Cannot create a user with no name, no ID, and no actor ID'
716 * Factory method to fetch whichever user has a given email confirmation code.
717 * This code is generated when an account is created or its e-mail address
720 * If the code is invalid or has expired, returns NULL.
722 * @param string $code Confirmation code
723 * @param int $flags User::READ_* bitfield
726 public static function newFromConfirmationCode( $code, $flags = 0 ) {
727 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
728 ?
wfGetDB( DB_MASTER
)
729 : wfGetDB( DB_REPLICA
);
731 $id = $db->selectField(
735 'user_email_token' => md5( $code ),
736 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
740 return $id ? self
::newFromId( $id ) : null;
744 * Create a new user object using data from session. If the login
745 * credentials are invalid, the result is an anonymous user.
747 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
750 public static function newFromSession( WebRequest
$request = null ) {
752 $user->mFrom
= 'session';
753 $user->mRequest
= $request;
758 * Create a new user object from a user row.
759 * The row should have the following fields from the user table in it:
760 * - either user_name or user_id to load further data if needed (or both)
762 * - all other fields (email, etc.)
763 * It is useless to provide the remaining fields if either user_id,
764 * user_name and user_real_name are not provided because the whole row
765 * will be loaded once more from the database when accessing them.
767 * @param stdClass $row A row from the user table
768 * @param array|null $data Further data to load into the object
769 * (see User::loadFromRow for valid keys)
772 public static function newFromRow( $row, $data = null ) {
774 $user->loadFromRow( $row, $data );
779 * Static factory method for creation of a "system" user from username.
781 * A "system" user is an account that's used to attribute logged actions
782 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
783 * might include the 'Maintenance script' or 'Conversion script' accounts
784 * used by various scripts in the maintenance/ directory or accounts such
785 * as 'MediaWiki message delivery' used by the MassMessage extension.
787 * This can optionally create the user if it doesn't exist, and "steal" the
788 * account if it does exist.
790 * "Stealing" an existing user is intended to make it impossible for normal
791 * authentication processes to use the account, effectively disabling the
792 * account for normal use:
793 * - Email is invalidated, to prevent account recovery by emailing a
794 * temporary password and to disassociate the account from the existing
796 * - The token is set to a magic invalid value, to kill existing sessions
797 * and to prevent $this->setToken() calls from resetting the token to a
799 * - SessionManager is instructed to prevent new sessions for the user, to
800 * do things like deauthorizing OAuth consumers.
801 * - AuthManager is instructed to revoke access, to invalidate or remove
802 * passwords and other credentials.
804 * @param string $name Username
805 * @param array $options Options are:
806 * - validate: As for User::getCanonicalName(), default 'valid'
807 * - create: Whether to create the user if it doesn't already exist, default true
808 * - steal: Whether to "disable" the account for normal use if it already
809 * exists, default false
813 public static function newSystemUser( $name, $options = [] ) {
815 'validate' => 'valid',
820 $name = self
::getCanonicalName( $name, $options['validate'] );
821 if ( $name === false ) {
825 $dbr = wfGetDB( DB_REPLICA
);
826 $userQuery = self
::getQueryInfo();
827 $row = $dbr->selectRow(
828 $userQuery['tables'],
829 $userQuery['fields'],
830 [ 'user_name' => $name ],
836 // Try the master database...
837 $dbw = wfGetDB( DB_MASTER
);
838 $row = $dbw->selectRow(
839 $userQuery['tables'],
840 $userQuery['fields'],
841 [ 'user_name' => $name ],
849 // No user. Create it?
850 return $options['create']
851 ? self
::createNew( $name, [ 'token' => self
::INVALID_TOKEN
] )
855 $user = self
::newFromRow( $row );
857 // A user is considered to exist as a non-system user if it can
858 // authenticate, or has an email set, or has a non-invalid token.
859 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
860 AuthManager
::singleton()->userCanAuthenticate( $name )
862 // User exists. Steal it?
863 if ( !$options['steal'] ) {
867 AuthManager
::singleton()->revokeAccessForUser( $name );
869 $user->invalidateEmail();
870 $user->mToken
= self
::INVALID_TOKEN
;
871 $user->saveSettings();
872 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
881 * Get the username corresponding to a given user ID
882 * @param int $id User ID
883 * @return string|bool The corresponding username
885 public static function whoIs( $id ) {
886 return UserCache
::singleton()->getProp( $id, 'name' );
890 * Get the real name of a user given their user ID
892 * @param int $id User ID
893 * @return string|bool The corresponding user's real name
895 public static function whoIsReal( $id ) {
896 return UserCache
::singleton()->getProp( $id, 'real_name' );
900 * Get database id given a user name
901 * @param string $name Username
902 * @param int $flags User::READ_* constant bitfield
903 * @return int|null The corresponding user's ID, or null if user is nonexistent
905 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
906 // Don't explode on self::$idCacheByName[$name] if $name is not a string but e.g. a User object
907 $name = (string)$name;
908 $nt = Title
::makeTitleSafe( NS_USER
, $name );
909 if ( is_null( $nt ) ) {
914 if ( !( $flags & self
::READ_LATEST
) && array_key_exists( $name, self
::$idCacheByName ) ) {
915 return self
::$idCacheByName[$name];
918 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
919 $db = wfGetDB( $index );
924 [ 'user_name' => $nt->getText() ],
929 if ( $s === false ) {
932 $result = (int)$s->user_id
;
935 self
::$idCacheByName[$name] = $result;
937 if ( count( self
::$idCacheByName ) > 1000 ) {
938 self
::$idCacheByName = [];
945 * Reset the cache used in idFromName(). For use in tests.
947 public static function resetIdByNameCache() {
948 self
::$idCacheByName = [];
952 * Does the string match an anonymous IP address?
954 * This function exists for username validation, in order to reject
955 * usernames which are similar in form to IP addresses. Strings such
956 * as 300.300.300.300 will return true because it looks like an IP
957 * address, despite not being strictly valid.
959 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
960 * address because the usemod software would "cloak" anonymous IP
961 * addresses like this, if we allowed accounts like this to be created
962 * new users could get the old edits of these anonymous users.
964 * @param string $name Name to match
967 public static function isIP( $name ) {
968 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
969 || IP
::isIPv6( $name );
973 * Is the user an IP range?
978 public function isIPRange() {
979 return IP
::isValidRange( $this->mName
);
983 * Is the input a valid username?
985 * Checks if the input is a valid username, we don't want an empty string,
986 * an IP address, anything that contains slashes (would mess up subpages),
987 * is longer than the maximum allowed username size or doesn't begin with
990 * @param string $name Name to match
993 public static function isValidUserName( $name ) {
994 global $wgMaxNameChars;
997 || self
::isIP( $name )
998 ||
strpos( $name, '/' ) !== false
999 ||
strlen( $name ) > $wgMaxNameChars
1000 ||
$name != MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name )
1005 // Ensure that the name can't be misresolved as a different title,
1006 // such as with extra namespace keys at the start.
1007 $parsed = Title
::newFromText( $name );
1008 if ( is_null( $parsed )
1009 ||
$parsed->getNamespace()
1010 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
1014 // Check an additional blacklist of troublemaker characters.
1015 // Should these be merged into the title char list?
1016 $unicodeBlacklist = '/[' .
1017 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
1018 '\x{00a0}' . # non-breaking space
1019 '\x{2000}-\x{200f}' . # various whitespace
1020 '\x{2028}-\x{202f}' . # breaks and control chars
1021 '\x{3000}' . # ideographic space
1022 '\x{e000}-\x{f8ff}' . # private use
1024 if ( preg_match( $unicodeBlacklist, $name ) ) {
1032 * Usernames which fail to pass this function will be blocked
1033 * from user login and new account registrations, but may be used
1034 * internally by batch processes.
1036 * If an account already exists in this form, login will be blocked
1037 * by a failure to pass this function.
1039 * @param string $name Name to match
1042 public static function isUsableName( $name ) {
1043 global $wgReservedUsernames;
1044 // Must be a valid username, obviously ;)
1045 if ( !self
::isValidUserName( $name ) ) {
1049 static $reservedUsernames = false;
1050 if ( !$reservedUsernames ) {
1051 $reservedUsernames = $wgReservedUsernames;
1052 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
1055 // Certain names may be reserved for batch processes.
1056 foreach ( $reservedUsernames as $reserved ) {
1057 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
1058 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->plain();
1060 if ( $reserved == $name ) {
1068 * Return the users who are members of the given group(s). In case of multiple groups,
1069 * users who are members of at least one of them are returned.
1071 * @param string|array $groups A single group name or an array of group names
1072 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
1073 * records; larger values are ignored.
1074 * @param int|null $after ID the user to start after
1075 * @return UserArrayFromResult
1077 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
1078 if ( $groups === [] ) {
1079 return UserArrayFromResult
::newFromIDs( [] );
1082 $groups = array_unique( (array)$groups );
1083 $limit = min( 5000, $limit );
1085 $conds = [ 'ug_group' => $groups ];
1086 if ( $after !== null ) {
1087 $conds[] = 'ug_user > ' . (int)$after;
1090 $dbr = wfGetDB( DB_REPLICA
);
1091 $ids = $dbr->selectFieldValues(
1098 'ORDER BY' => 'ug_user',
1102 return UserArray
::newFromIDs( $ids );
1106 * Usernames which fail to pass this function will be blocked
1107 * from new account registrations, but may be used internally
1108 * either by batch processes or by user accounts which have
1109 * already been created.
1111 * Additional blacklisting may be added here rather than in
1112 * isValidUserName() to avoid disrupting existing accounts.
1114 * @param string $name String to match
1117 public static function isCreatableName( $name ) {
1118 global $wgInvalidUsernameCharacters;
1120 // Ensure that the username isn't longer than 235 bytes, so that
1121 // (at least for the builtin skins) user javascript and css files
1122 // will work. (T25080)
1123 if ( strlen( $name ) > 235 ) {
1124 wfDebugLog( 'username', __METHOD__
.
1125 ": '$name' invalid due to length" );
1129 // Preg yells if you try to give it an empty string
1130 if ( $wgInvalidUsernameCharacters !== '' &&
1131 preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name )
1133 wfDebugLog( 'username', __METHOD__
.
1134 ": '$name' invalid due to wgInvalidUsernameCharacters" );
1138 return self
::isUsableName( $name );
1142 * Is the input a valid password for this user?
1144 * @param string $password Desired password
1147 public function isValidPassword( $password ) {
1148 // simple boolean wrapper for checkPasswordValidity
1149 return $this->checkPasswordValidity( $password )->isGood();
1153 * Given unvalidated password input, return error message on failure.
1155 * @param string $password Desired password
1156 * @return bool|string|array True on success, string or array of error message on failure
1157 * @deprecated since 1.33, use checkPasswordValidity
1159 public function getPasswordValidity( $password ) {
1160 wfDeprecated( __METHOD__
, '1.33' );
1162 $result = $this->checkPasswordValidity( $password );
1163 if ( $result->isGood() ) {
1168 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
1169 $messages[] = $error['message'];
1171 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
1172 $messages[] = $warning['message'];
1174 if ( count( $messages ) === 1 ) {
1175 return $messages[0];
1182 * Check if this is a valid password for this user
1184 * Returns a Status object with a set of messages describing
1185 * problems with the password. If the return status is fatal,
1186 * the action should be refused and the password should not be
1187 * checked at all (this is mainly meant for DoS mitigation).
1188 * If the return value is OK but not good, the password can be checked,
1189 * but the user should not be able to set their password to this.
1190 * The value of the returned Status object will be an array which
1191 * can have the following fields:
1192 * - forceChange (bool): if set to true, the user should not be
1193 * allowed to log with this password unless they change it during
1194 * the login process (see ResetPasswordSecondaryAuthenticationProvider).
1195 * - suggestChangeOnLogin (bool): if set to true, the user should be prompted for
1196 * a password change on login.
1198 * @param string $password Desired password
1202 public function checkPasswordValidity( $password ) {
1203 global $wgPasswordPolicy;
1205 $upp = new UserPasswordPolicy(
1206 $wgPasswordPolicy['policies'],
1207 $wgPasswordPolicy['checks']
1210 $status = Status
::newGood( [] );
1211 $result = false; // init $result to false for the internal checks
1213 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1214 $status->error( $result );
1218 if ( $result === false ) {
1219 $status->merge( $upp->checkUserPassword( $this, $password ), true );
1223 if ( $result === true ) {
1227 $status->error( $result );
1228 return $status; // the isValidPassword hook set a string $result and returned true
1232 * Given unvalidated user input, return a canonical username, or false if
1233 * the username is invalid.
1234 * @param string $name User input
1235 * @param string|bool $validate Type of validation to use:
1236 * - false No validation
1237 * - 'valid' Valid for batch processes
1238 * - 'usable' Valid for batch processes and login
1239 * - 'creatable' Valid for batch processes, login and account creation
1241 * @throws InvalidArgumentException
1242 * @return bool|string
1244 public static function getCanonicalName( $name, $validate = 'valid' ) {
1245 // Force usernames to capital
1246 $name = MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name );
1248 # Reject names containing '#'; these will be cleaned up
1249 # with title normalisation, but then it's too late to
1251 if ( strpos( $name, '#' ) !== false ) {
1255 // Clean up name according to title rules,
1256 // but only when validation is requested (T14654)
1257 $t = ( $validate !== false ) ?
1258 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1259 // Check for invalid titles
1260 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1264 $name = $t->getText();
1266 switch ( $validate ) {
1270 if ( !self
::isValidUserName( $name ) ) {
1275 if ( !self
::isUsableName( $name ) ) {
1280 if ( !self
::isCreatableName( $name ) ) {
1285 throw new InvalidArgumentException(
1286 'Invalid parameter value for $validate in ' . __METHOD__
);
1292 * Return a random password.
1294 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1295 * @return string New random password
1297 public static function randomPassword() {
1298 global $wgMinimalPasswordLength;
1299 return PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1303 * Set cached properties to default.
1305 * @note This no longer clears uncached lazy-initialised properties;
1306 * the constructor does that instead.
1308 * @param string|bool $name
1310 public function loadDefaults( $name = false ) {
1312 $this->mName
= $name;
1313 $this->mActorId
= null;
1314 $this->mRealName
= '';
1316 $this->mOptionOverrides
= null;
1317 $this->mOptionsLoaded
= false;
1319 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1320 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1321 if ( $loggedOut !== 0 ) {
1322 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1324 $this->mTouched
= '1'; # Allow any pages to be cached
1327 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1328 $this->mEmailAuthenticated
= null;
1329 $this->mEmailToken
= '';
1330 $this->mEmailTokenExpires
= null;
1331 $this->mRegistration
= wfTimestamp( TS_MW
);
1332 $this->mGroupMemberships
= [];
1334 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1338 * Return whether an item has been loaded.
1340 * @param string $item Item to check. Current possibilities:
1344 * @param string $all 'all' to check if the whole object has been loaded
1345 * or any other string to check if only the item is available (e.g.
1349 public function isItemLoaded( $item, $all = 'all' ) {
1350 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1351 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1355 * Set that an item has been loaded
1357 * @param string $item
1359 protected function setItemLoaded( $item ) {
1360 if ( is_array( $this->mLoadedItems
) ) {
1361 $this->mLoadedItems
[$item] = true;
1366 * Load user data from the session.
1368 * @return bool True if the user is logged in, false otherwise.
1370 private function loadFromSession() {
1373 Hooks
::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1374 if ( $result !== null ) {
1378 // MediaWiki\Session\Session already did the necessary authentication of the user
1379 // returned here, so just use it if applicable.
1380 $session = $this->getRequest()->getSession();
1381 $user = $session->getUser();
1382 if ( $user->isLoggedIn() ) {
1383 $this->loadFromUserObject( $user );
1384 if ( $user->isBlocked() ) {
1385 // If this user is autoblocked, set a cookie to track the Block. This has to be done on
1386 // every session load, because an autoblocked editor might not edit again from the same
1387 // IP address after being blocked.
1388 $this->trackBlockWithCookie();
1391 // Other code expects these to be set in the session, so set them.
1392 $session->set( 'wsUserID', $this->getId() );
1393 $session->set( 'wsUserName', $this->getName() );
1394 $session->set( 'wsToken', $this->getToken() );
1403 * Set the 'BlockID' cookie depending on block type and user authentication status.
1405 public function trackBlockWithCookie() {
1406 $block = $this->getBlock();
1408 if ( $block && $this->getRequest()->getCookie( 'BlockID' ) === null
1409 && $block->shouldTrackWithCookie( $this->isAnon() )
1411 $block->setCookie( $this->getRequest()->response() );
1416 * Load user and user_group data from the database.
1417 * $this->mId must be set, this is how the user is identified.
1419 * @param int $flags User::READ_* constant bitfield
1420 * @return bool True if the user exists, false if the user is anonymous
1422 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1424 $this->mId
= intval( $this->mId
);
1426 if ( !$this->mId
) {
1427 // Anonymous users are not in the database
1428 $this->loadDefaults();
1432 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1433 $db = wfGetDB( $index );
1435 $userQuery = self
::getQueryInfo();
1436 $s = $db->selectRow(
1437 $userQuery['tables'],
1438 $userQuery['fields'],
1439 [ 'user_id' => $this->mId
],
1445 $this->queryFlagsUsed
= $flags;
1446 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1448 if ( $s !== false ) {
1449 // Initialise user table data
1450 $this->loadFromRow( $s );
1451 $this->mGroupMemberships
= null; // deferred
1452 $this->getEditCount(); // revalidation for nulls
1458 $this->loadDefaults();
1464 * Initialize this object from a row from the user table.
1466 * @param stdClass $row Row from the user table to load.
1467 * @param array|null $data Further user data to load into the object
1469 * user_groups Array of arrays or stdClass result rows out of the user_groups
1470 * table. Previously you were supposed to pass an array of strings
1471 * here, but we also need expiry info nowadays, so an array of
1472 * strings is ignored.
1473 * user_properties Array with properties out of the user_properties table
1475 protected function loadFromRow( $row, $data = null ) {
1476 global $wgActorTableSchemaMigrationStage;
1478 if ( !is_object( $row ) ) {
1479 throw new InvalidArgumentException( '$row must be an object' );
1484 $this->mGroupMemberships
= null; // deferred
1486 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
1487 // but it does little harm and might be needed for write callers loading a User.
1488 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
1489 if ( isset( $row->actor_id
) ) {
1490 $this->mActorId
= (int)$row->actor_id
;
1491 if ( $this->mActorId
!== 0 ) {
1492 $this->mFrom
= 'actor';
1494 $this->setItemLoaded( 'actor' );
1500 if ( isset( $row->user_name
) && $row->user_name
!== '' ) {
1501 $this->mName
= $row->user_name
;
1502 $this->mFrom
= 'name';
1503 $this->setItemLoaded( 'name' );
1508 if ( isset( $row->user_real_name
) ) {
1509 $this->mRealName
= $row->user_real_name
;
1510 $this->setItemLoaded( 'realname' );
1515 if ( isset( $row->user_id
) ) {
1516 $this->mId
= intval( $row->user_id
);
1517 if ( $this->mId
!== 0 ) {
1518 $this->mFrom
= 'id';
1520 $this->setItemLoaded( 'id' );
1525 if ( isset( $row->user_id
) && isset( $row->user_name
) && $row->user_name
!== '' ) {
1526 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1529 if ( isset( $row->user_editcount
) ) {
1530 $this->mEditCount
= $row->user_editcount
;
1535 if ( isset( $row->user_touched
) ) {
1536 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1541 if ( isset( $row->user_token
) ) {
1542 // The definition for the column is binary(32), so trim the NULs
1543 // that appends. The previous definition was char(32), so trim
1545 $this->mToken
= rtrim( $row->user_token
, " \0" );
1546 if ( $this->mToken
=== '' ) {
1547 $this->mToken
= null;
1553 if ( isset( $row->user_email
) ) {
1554 $this->mEmail
= $row->user_email
;
1555 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1556 $this->mEmailToken
= $row->user_email_token
;
1557 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1558 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1564 $this->mLoadedItems
= true;
1567 if ( is_array( $data ) ) {
1568 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1569 if ( $data['user_groups'] === [] ) {
1570 $this->mGroupMemberships
= [];
1572 $firstGroup = reset( $data['user_groups'] );
1573 if ( is_array( $firstGroup ) ||
is_object( $firstGroup ) ) {
1574 $this->mGroupMemberships
= [];
1575 foreach ( $data['user_groups'] as $row ) {
1576 $ugm = UserGroupMembership
::newFromRow( (object)$row );
1577 $this->mGroupMemberships
[$ugm->getGroup()] = $ugm;
1582 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1583 $this->loadOptions( $data['user_properties'] );
1589 * Load the data for this user object from another user object.
1593 protected function loadFromUserObject( $user ) {
1595 foreach ( self
::$mCacheVars as $var ) {
1596 $this->$var = $user->$var;
1601 * Load the groups from the database if they aren't already loaded.
1603 private function loadGroups() {
1604 if ( is_null( $this->mGroupMemberships
) ) {
1605 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1606 ?
wfGetDB( DB_MASTER
)
1607 : wfGetDB( DB_REPLICA
);
1608 $this->mGroupMemberships
= UserGroupMembership
::getMembershipsForUser(
1614 * Add the user to the group if he/she meets given criteria.
1616 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1617 * possible to remove manually via Special:UserRights. In such case it
1618 * will not be re-added automatically. The user will also not lose the
1619 * group if they no longer meet the criteria.
1621 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1623 * @return array Array of groups the user has been promoted to.
1625 * @see $wgAutopromoteOnce
1627 public function addAutopromoteOnceGroups( $event ) {
1628 global $wgAutopromoteOnceLogInRC;
1630 if ( wfReadOnly() ||
!$this->getId() ) {
1634 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1635 if ( $toPromote === [] ) {
1639 if ( !$this->checkAndSetTouched() ) {
1640 return []; // raced out (bug T48834)
1643 $oldGroups = $this->getGroups(); // previous groups
1644 $oldUGMs = $this->getGroupMemberships();
1645 foreach ( $toPromote as $group ) {
1646 $this->addGroup( $group );
1648 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1649 $newUGMs = $this->getGroupMemberships();
1651 // update groups in external authentication database
1652 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );
1654 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1655 $logEntry->setPerformer( $this );
1656 $logEntry->setTarget( $this->getUserPage() );
1657 $logEntry->setParameters( [
1658 '4::oldgroups' => $oldGroups,
1659 '5::newgroups' => $newGroups,
1661 $logid = $logEntry->insert();
1662 if ( $wgAutopromoteOnceLogInRC ) {
1663 $logEntry->publish( $logid );
1670 * Builds update conditions. Additional conditions may be added to $conditions to
1671 * protected against race conditions using a compare-and-set (CAS) mechanism
1672 * based on comparing $this->mTouched with the user_touched field.
1674 * @param Database $db
1675 * @param array $conditions WHERE conditions for use with Database::update
1676 * @return array WHERE conditions for use with Database::update
1678 protected function makeUpdateConditions( IDatabase
$db, array $conditions ) {
1679 if ( $this->mTouched
) {
1680 // CAS check: only update if the row wasn't changed sicne it was loaded.
1681 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1688 * Bump user_touched if it didn't change since this object was loaded
1690 * On success, the mTouched field is updated.
1691 * The user serialization cache is always cleared.
1693 * @return bool Whether user_touched was actually updated
1696 protected function checkAndSetTouched() {
1699 if ( !$this->mId
) {
1700 return false; // anon
1703 // Get a new user_touched that is higher than the old one
1704 $newTouched = $this->newTouchedTimestamp();
1706 $dbw = wfGetDB( DB_MASTER
);
1707 $dbw->update( 'user',
1708 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1709 $this->makeUpdateConditions( $dbw, [
1710 'user_id' => $this->mId
,
1714 $success = ( $dbw->affectedRows() > 0 );
1717 $this->mTouched
= $newTouched;
1718 $this->clearSharedCache();
1720 // Clears on failure too since that is desired if the cache is stale
1721 $this->clearSharedCache( 'refresh' );
1728 * Clear various cached data stored in this object. The cache of the user table
1729 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1731 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1732 * given source. May be "name", "id", "actor", "defaults", "session", or false for no reload.
1734 public function clearInstanceCache( $reloadFrom = false ) {
1735 $this->mNewtalk
= -1;
1736 $this->mDatePreference
= null;
1737 $this->mBlockedby
= -1; # Unset
1738 $this->mHash
= false;
1739 $this->mRights
= null;
1740 $this->mEffectiveGroups
= null;
1741 $this->mImplicitGroups
= null;
1742 $this->mGroupMemberships
= null;
1743 $this->mOptions
= null;
1744 $this->mOptionsLoaded
= false;
1745 $this->mEditCount
= null;
1747 if ( $reloadFrom ) {
1748 $this->mLoadedItems
= [];
1749 $this->mFrom
= $reloadFrom;
1753 /** @var array|null */
1754 private static $defOpt = null;
1755 /** @var string|null */
1756 private static $defOptLang = null;
1759 * Reset the process cache of default user options. This is only necessary
1760 * if the wiki configuration has changed since defaults were calculated,
1761 * and as such should only be performed inside the testing suite that
1762 * regularly changes wiki configuration.
1764 public static function resetGetDefaultOptionsForTestsOnly() {
1765 Assert
::invariant( defined( 'MW_PHPUNIT_TEST' ), 'Unit tests only' );
1766 self
::$defOpt = null;
1767 self
::$defOptLang = null;
1771 * Combine the language default options with any site-specific options
1772 * and add the default language variants.
1774 * @return array Array of String options
1776 public static function getDefaultOptions() {
1777 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgDefaultSkin;
1779 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
1780 if ( self
::$defOpt !== null && self
::$defOptLang === $contLang->getCode() ) {
1781 // The content language does not change (and should not change) mid-request, but the
1782 // unit tests change it anyway, and expect this method to return values relevant to the
1783 // current content language.
1784 return self
::$defOpt;
1787 self
::$defOpt = $wgDefaultUserOptions;
1788 // Default language setting
1789 self
::$defOptLang = $contLang->getCode();
1790 self
::$defOpt['language'] = self
::$defOptLang;
1791 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1792 if ( $langCode === $contLang->getCode() ) {
1793 self
::$defOpt['variant'] = $langCode;
1795 self
::$defOpt["variant-$langCode"] = $langCode;
1799 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1800 // since extensions may change the set of searchable namespaces depending
1801 // on user groups/permissions.
1802 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1803 self
::$defOpt['searchNs' . $nsnum] = (bool)$val;
1805 self
::$defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1807 Hooks
::run( 'UserGetDefaultOptions', [ &self
::$defOpt ] );
1809 return self
::$defOpt;
1813 * Get a given default option value.
1815 * @param string $opt Name of option to retrieve
1816 * @return string Default option value
1818 public static function getDefaultOption( $opt ) {
1819 $defOpts = self
::getDefaultOptions();
1820 return $defOpts[$opt] ??
null;
1824 * Get blocking information
1825 * @param bool $fromReplica Whether to check the replica DB first.
1826 * To improve performance, non-critical checks are done against replica DBs.
1827 * Check when actually saving should be done against master.
1829 private function getBlockedStatus( $fromReplica = true ) {
1830 global $wgProxyWhitelist, $wgApplyIpBlocksToXff, $wgSoftBlockRanges;
1832 if ( $this->mBlockedby
!= -1 ) {
1836 wfDebug( __METHOD__
. ": checking...\n" );
1838 // Initialize data...
1839 // Otherwise something ends up stomping on $this->mBlockedby when
1840 // things get lazy-loaded later, causing false positive block hits
1841 // due to -1 !== 0. Probably session-related... Nothing should be
1842 // overwriting mBlockedby, surely?
1845 # We only need to worry about passing the IP address to the Block generator if the
1846 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1847 # know which IP address they're actually coming from
1849 $sessionUser = RequestContext
::getMain()->getUser();
1850 // the session user is set up towards the end of Setup.php. Until then,
1851 // assume it's a logged-out user.
1852 $globalUserName = $sessionUser->isSafeToLoad()
1853 ?
$sessionUser->getName()
1854 : IP
::sanitizeIP( $sessionUser->getRequest()->getIP() );
1855 if ( $this->getName() === $globalUserName && !$this->isAllowed( 'ipblock-exempt' ) ) {
1856 $ip = $this->getRequest()->getIP();
1860 $block = Block
::newFromTarget( $this, $ip, !$fromReplica );
1863 if ( !$block instanceof Block
) {
1864 $block = $this->getBlockFromCookieValue( $this->getRequest()->getCookie( 'BlockID' ) );
1868 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1870 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1871 $block = new Block( [
1872 'byText' => wfMessage( 'proxyblocker' )->text(),
1873 'reason' => wfMessage( 'proxyblockreason' )->plain(),
1875 'systemBlock' => 'proxy',
1877 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1878 $block = new Block( [
1879 'byText' => wfMessage( 'sorbs' )->text(),
1880 'reason' => wfMessage( 'sorbsreason' )->plain(),
1882 'systemBlock' => 'dnsbl',
1887 // (T25343) Apply IP blocks to the contents of XFF headers, if enabled
1888 if ( !$block instanceof Block
1889 && $wgApplyIpBlocksToXff
1891 && !in_array( $ip, $wgProxyWhitelist )
1893 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1894 $xff = array_map( 'trim', explode( ',', $xff ) );
1895 $xff = array_diff( $xff, [ $ip ] );
1896 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$fromReplica );
1897 $block = Block
::chooseBlock( $xffblocks, $xff );
1898 if ( $block instanceof Block
) {
1899 # Mangle the reason to alert the user that the block
1900 # originated from matching the X-Forwarded-For header.
1901 $block->setReason( wfMessage( 'xffblockreason', $block->getReason() )->plain() );
1905 if ( !$block instanceof Block
1908 && IP
::isInRanges( $ip, $wgSoftBlockRanges )
1910 $block = new Block( [
1912 'byText' => 'MediaWiki default',
1913 'reason' => wfMessage( 'softblockrangesreason', $ip )->plain(),
1915 'systemBlock' => 'wgSoftBlockRanges',
1919 if ( $block instanceof Block
) {
1920 wfDebug( __METHOD__
. ": Found block.\n" );
1921 $this->mBlock
= $block;
1922 $this->mBlockedby
= $block->getByName();
1923 $this->mBlockreason
= $block->getReason();
1924 $this->mHideName
= $block->getHideName();
1925 $this->mAllowUsertalk
= $block->isUsertalkEditAllowed();
1927 $this->mBlock
= null;
1928 $this->mBlockedby
= '';
1929 $this->mBlockreason
= '';
1930 $this->mHideName
= 0;
1931 $this->mAllowUsertalk
= false;
1934 // Avoid PHP 7.1 warning of passing $this by reference
1937 Hooks
::run( 'GetBlockedStatus', [ &$thisUser ] );
1941 * Try to load a Block from an ID given in a cookie value.
1942 * @param string|null $blockCookieVal The cookie value to check.
1943 * @return Block|bool The Block object, or false if none could be loaded.
1945 protected function getBlockFromCookieValue( $blockCookieVal ) {
1946 // Make sure there's something to check. The cookie value must start with a number.
1947 if ( strlen( $blockCookieVal ) < 1 ||
!is_numeric( substr( $blockCookieVal, 0, 1 ) ) ) {
1950 // Load the Block from the ID in the cookie.
1951 $blockCookieId = Block
::getIdFromCookieValue( $blockCookieVal );
1952 if ( $blockCookieId !== null ) {
1953 // An ID was found in the cookie.
1954 $tmpBlock = Block
::newFromID( $blockCookieId );
1955 if ( $tmpBlock instanceof Block
) {
1956 $config = RequestContext
::getMain()->getConfig();
1958 switch ( $tmpBlock->getType() ) {
1959 case Block
::TYPE_USER
:
1960 $blockIsValid = !$tmpBlock->isExpired() && $tmpBlock->isAutoblocking();
1961 $useBlockCookie = ( $config->get( 'CookieSetOnAutoblock' ) === true );
1963 case Block
::TYPE_IP
:
1964 case Block
::TYPE_RANGE
:
1965 // If block is type IP or IP range, load only if user is not logged in (T152462)
1966 $blockIsValid = !$tmpBlock->isExpired() && !$this->isLoggedIn();
1967 $useBlockCookie = ( $config->get( 'CookieSetOnIpBlock' ) === true );
1970 $blockIsValid = false;
1971 $useBlockCookie = false;
1974 if ( $blockIsValid && $useBlockCookie ) {
1979 // If the block is not valid, remove the cookie.
1980 Block
::clearCookie( $this->getRequest()->response() );
1982 // If the block doesn't exist, remove the cookie.
1983 Block
::clearCookie( $this->getRequest()->response() );
1990 * Whether the given IP is in a DNS blacklist.
1992 * @param string $ip IP to check
1993 * @param bool $checkWhitelist Whether to check the whitelist first
1994 * @return bool True if blacklisted.
1996 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1997 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1999 if ( !$wgEnableDnsBlacklist ||
2000 ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
2005 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
2009 * Whether the given IP is in a given DNS blacklist.
2011 * @param string $ip IP to check
2012 * @param string|array $bases Array of Strings: URL of the DNS blacklist
2013 * @return bool True if blacklisted.
2015 public function inDnsBlacklist( $ip, $bases ) {
2017 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
2018 if ( IP
::isIPv4( $ip ) ) {
2019 // Reverse IP, T23255
2020 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
2022 foreach ( (array)$bases as $base ) {
2024 // If we have an access key, use that too (ProjectHoneypot, etc.)
2026 if ( is_array( $base ) ) {
2027 if ( count( $base ) >= 2 ) {
2028 // Access key is 1, base URL is 0
2029 $host = "{$base[1]}.$ipReversed.{$base[0]}";
2031 $host = "$ipReversed.{$base[0]}";
2033 $basename = $base[0];
2035 $host = "$ipReversed.$base";
2039 $ipList = gethostbynamel( $host );
2042 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
2047 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
2055 * Check if an IP address is in the local proxy list
2061 public static function isLocallyBlockedProxy( $ip ) {
2062 global $wgProxyList;
2064 if ( !$wgProxyList ) {
2068 if ( !is_array( $wgProxyList ) ) {
2069 // Load values from the specified file
2070 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
2073 $resultProxyList = [];
2074 $deprecatedIPEntries = [];
2076 // backward compatibility: move all ip addresses in keys to values
2077 foreach ( $wgProxyList as $key => $value ) {
2078 $keyIsIP = IP
::isIPAddress( $key );
2079 $valueIsIP = IP
::isIPAddress( $value );
2080 if ( $keyIsIP && !$valueIsIP ) {
2081 $deprecatedIPEntries[] = $key;
2082 $resultProxyList[] = $key;
2083 } elseif ( $keyIsIP && $valueIsIP ) {
2084 $deprecatedIPEntries[] = $key;
2085 $resultProxyList[] = $key;
2086 $resultProxyList[] = $value;
2088 $resultProxyList[] = $value;
2092 if ( $deprecatedIPEntries ) {
2094 'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
2095 implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
2098 $proxyListIPSet = new IPSet( $resultProxyList );
2099 return $proxyListIPSet->match( $ip );
2103 * Is this user subject to rate limiting?
2105 * @return bool True if rate limited
2107 public function isPingLimitable() {
2108 global $wgRateLimitsExcludedIPs;
2109 if ( IP
::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
2110 // No other good way currently to disable rate limits
2111 // for specific IPs. :P
2112 // But this is a crappy hack and should die.
2115 return !$this->isAllowed( 'noratelimit' );
2119 * Primitive rate limits: enforce maximum actions per time period
2120 * to put a brake on flooding.
2122 * The method generates both a generic profiling point and a per action one
2123 * (suffix being "-$action".
2125 * @note When using a shared cache like memcached, IP-address
2126 * last-hit counters will be shared across wikis.
2128 * @param string $action Action to enforce; 'edit' if unspecified
2129 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
2130 * @return bool True if a rate limiter was tripped
2132 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
2133 // Avoid PHP 7.1 warning of passing $this by reference
2135 // Call the 'PingLimiter' hook
2137 if ( !Hooks
::run( 'PingLimiter', [ &$user, $action, &$result, $incrBy ] ) ) {
2141 global $wgRateLimits;
2142 if ( !isset( $wgRateLimits[$action] ) ) {
2146 $limits = array_merge(
2147 [ '&can-bypass' => true ],
2148 $wgRateLimits[$action]
2151 // Some groups shouldn't trigger the ping limiter, ever
2152 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
2157 $id = $this->getId();
2159 $isNewbie = $this->isNewbie();
2160 $cache = ObjectCache
::getLocalClusterInstance();
2164 if ( isset( $limits['anon'] ) ) {
2165 $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
2167 } elseif ( isset( $limits['user'] ) ) {
2168 // limits for logged-in users
2169 $userLimit = $limits['user'];
2172 // limits for anons and for newbie logged-in users
2175 if ( isset( $limits['ip'] ) ) {
2176 $ip = $this->getRequest()->getIP();
2177 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
2179 // subnet-based limits
2180 if ( isset( $limits['subnet'] ) ) {
2181 $ip = $this->getRequest()->getIP();
2182 $subnet = IP
::getSubnet( $ip );
2183 if ( $subnet !== false ) {
2184 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
2189 // Check for group-specific permissions
2190 // If more than one group applies, use the group with the highest limit ratio (max/period)
2191 foreach ( $this->getGroups() as $group ) {
2192 if ( isset( $limits[$group] ) ) {
2193 if ( $userLimit === false
2194 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
2196 $userLimit = $limits[$group];
2201 // limits for newbie logged-in users (override all the normal user limits)
2202 if ( $id !== 0 && $isNewbie && isset( $limits['newbie'] ) ) {
2203 $userLimit = $limits['newbie'];
2206 // Set the user limit key
2207 if ( $userLimit !== false ) {
2208 // phan is confused because &can-bypass's value is a bool, so it assumes
2209 // that $userLimit is also a bool here.
2210 // @phan-suppress-next-line PhanTypeInvalidExpressionArrayDestructuring
2211 list( $max, $period ) = $userLimit;
2212 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
2213 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
2216 // ip-based limits for all ping-limitable users
2217 if ( isset( $limits['ip-all'] ) ) {
2218 $ip = $this->getRequest()->getIP();
2219 // ignore if user limit is more permissive
2220 if ( $isNewbie ||
$userLimit === false
2221 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
2222 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
2226 // subnet-based limits for all ping-limitable users
2227 if ( isset( $limits['subnet-all'] ) ) {
2228 $ip = $this->getRequest()->getIP();
2229 $subnet = IP
::getSubnet( $ip );
2230 if ( $subnet !== false ) {
2231 // ignore if user limit is more permissive
2232 if ( $isNewbie ||
$userLimit === false
2233 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
2234 > $userLimit[0] / $userLimit[1] ) {
2235 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
2241 foreach ( $keys as $key => $limit ) {
2242 // phan is confused because &can-bypass's value is a bool, so it assumes
2243 // that $userLimit is also a bool here.
2244 // @phan-suppress-next-line PhanTypeInvalidExpressionArrayDestructuring
2245 list( $max, $period ) = $limit;
2246 $summary = "(limit $max in {$period}s)";
2247 $count = $cache->get( $key );
2250 if ( $count >= $max ) {
2251 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
2252 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
2255 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
2258 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
2259 if ( $incrBy > 0 ) {
2260 $cache->add( $key, 0, intval( $period ) ); // first ping
2263 if ( $incrBy > 0 ) {
2264 $cache->incr( $key, $incrBy );
2272 * Check if user is blocked
2274 * @param bool $fromReplica Whether to check the replica DB instead of
2275 * the master. Hacked from false due to horrible probs on site.
2276 * @return bool True if blocked, false otherwise
2278 public function isBlocked( $fromReplica = true ) {
2279 return $this->getBlock( $fromReplica ) instanceof Block
&&
2280 $this->getBlock()->appliesToRight( 'edit' );
2284 * Get the block affecting the user, or null if the user is not blocked
2286 * @param bool $fromReplica Whether to check the replica DB instead of the master
2287 * @return Block|null
2289 public function getBlock( $fromReplica = true ) {
2290 $this->getBlockedStatus( $fromReplica );
2291 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
2295 * Check if user is blocked from editing a particular article
2297 * @param Title $title Title to check
2298 * @param bool $fromReplica Whether to check the replica DB instead of the master
2300 * @throws MWException
2302 * @deprecated since 1.33,
2303 * use MediaWikiServices::getInstance()->getPermissionManager()->isBlockedFrom(..)
2306 public function isBlockedFrom( $title, $fromReplica = false ) {
2307 return MediaWikiServices
::getInstance()->getPermissionManager()
2308 ->isBlockedFrom( $this, $title, $fromReplica );
2312 * If user is blocked, return the name of the user who placed the block
2313 * @return string Name of blocker
2315 public function blockedBy() {
2316 $this->getBlockedStatus();
2317 return $this->mBlockedby
;
2321 * If user is blocked, return the specified reason for the block
2322 * @return string Blocking reason
2324 public function blockedFor() {
2325 $this->getBlockedStatus();
2326 return $this->mBlockreason
;
2330 * If user is blocked, return the ID for the block
2331 * @return int Block ID
2333 public function getBlockId() {
2334 $this->getBlockedStatus();
2335 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2339 * Check if user is blocked on all wikis.
2340 * Do not use for actual edit permission checks!
2341 * This is intended for quick UI checks.
2343 * @param string $ip IP address, uses current client if none given
2344 * @return bool True if blocked, false otherwise
2346 public function isBlockedGlobally( $ip = '' ) {
2347 return $this->getGlobalBlock( $ip ) instanceof Block
;
2351 * Check if user is blocked on all wikis.
2352 * Do not use for actual edit permission checks!
2353 * This is intended for quick UI checks.
2355 * @param string $ip IP address, uses current client if none given
2356 * @return Block|null Block object if blocked, null otherwise
2357 * @throws FatalError
2358 * @throws MWException
2360 public function getGlobalBlock( $ip = '' ) {
2361 if ( $this->mGlobalBlock
!== null ) {
2362 return $this->mGlobalBlock ?
: null;
2364 // User is already an IP?
2365 if ( IP
::isIPAddress( $this->getName() ) ) {
2366 $ip = $this->getName();
2368 $ip = $this->getRequest()->getIP();
2370 // Avoid PHP 7.1 warning of passing $this by reference
2374 Hooks
::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
2376 if ( $blocked && $block === null ) {
2377 // back-compat: UserIsBlockedGlobally didn't have $block param first
2378 $block = new Block( [
2380 'systemBlock' => 'global-block'
2384 $this->mGlobalBlock
= $blocked ?
$block : false;
2385 return $this->mGlobalBlock ?
: null;
2389 * Check if user account is locked
2391 * @return bool True if locked, false otherwise
2393 public function isLocked() {
2394 if ( $this->mLocked
!== null ) {
2395 return $this->mLocked
;
2398 $this->mLocked
= false;
2399 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2400 return $this->mLocked
;
2404 * Check if user account is hidden
2406 * @return bool True if hidden, false otherwise
2408 public function isHidden() {
2409 if ( $this->mHideName
!== null ) {
2410 return (bool)$this->mHideName
;
2412 $this->getBlockedStatus();
2413 if ( !$this->mHideName
) {
2415 $this->mHideName
= false;
2416 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2418 return (bool)$this->mHideName
;
2422 * Get the user's ID.
2423 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2425 public function getId() {
2426 if ( $this->mId
=== null && $this->mName
!== null && self
::isIP( $this->mName
) ) {
2427 // Special case, we know the user is anonymous
2431 if ( !$this->isItemLoaded( 'id' ) ) {
2432 // Don't load if this was initialized from an ID
2436 return (int)$this->mId
;
2440 * Set the user and reload all fields according to a given ID
2441 * @param int $v User ID to reload
2443 public function setId( $v ) {
2445 $this->clearInstanceCache( 'id' );
2449 * Get the user name, or the IP of an anonymous user
2450 * @return string User's name or IP address
2452 public function getName() {
2453 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2454 // Special case optimisation
2455 return $this->mName
;
2459 if ( $this->mName
=== false ) {
2461 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2464 return $this->mName
;
2468 * Set the user name.
2470 * This does not reload fields from the database according to the given
2471 * name. Rather, it is used to create a temporary "nonexistent user" for
2472 * later addition to the database. It can also be used to set the IP
2473 * address for an anonymous user to something other than the current
2476 * @note User::newFromName() has roughly the same function, when the named user
2478 * @param string $str New user name to set
2480 public function setName( $str ) {
2482 $this->mName
= $str;
2486 * Get the user's actor ID.
2488 * @param IDatabase|null $dbw Assign a new actor ID, using this DB handle, if none exists
2489 * @return int The actor's ID, or 0 if no actor ID exists and $dbw was null
2491 public function getActorId( IDatabase
$dbw = null ) {
2492 global $wgActorTableSchemaMigrationStage;
2494 // Technically we should always return 0 without SCHEMA_COMPAT_READ_NEW,
2495 // but it does little harm and might be needed for write callers loading a User.
2496 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) ) {
2500 if ( !$this->isItemLoaded( 'actor' ) ) {
2504 // Currently $this->mActorId might be null if $this was loaded from a
2505 // cache entry that was written when $wgActorTableSchemaMigrationStage
2506 // was SCHEMA_COMPAT_OLD. Once that is no longer a possibility (i.e. when
2507 // User::VERSION is incremented after $wgActorTableSchemaMigrationStage
2508 // has been removed), that condition may be removed.
2509 if ( $this->mActorId
=== null ||
!$this->mActorId
&& $dbw ) {
2511 'actor_user' => $this->getId() ?
: null,
2512 'actor_name' => (string)$this->getName(),
2515 if ( $q['actor_user'] === null && self
::isUsableName( $q['actor_name'] ) ) {
2516 throw new CannotCreateActorException(
2517 'Cannot create an actor for a usable name that is not an existing user'
2520 if ( $q['actor_name'] === '' ) {
2521 throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
2523 $dbw->insert( 'actor', $q, __METHOD__
, [ 'IGNORE' ] );
2524 if ( $dbw->affectedRows() ) {
2525 $this->mActorId
= (int)$dbw->insertId();
2528 // Use LOCK IN SHARE MODE to bypass any MySQL REPEATABLE-READ snapshot.
2529 $this->mActorId
= (int)$dbw->selectField(
2534 [ 'LOCK IN SHARE MODE' ]
2536 if ( !$this->mActorId
) {
2537 throw new CannotCreateActorException(
2538 "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
2542 $this->invalidateCache();
2544 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2545 $db = wfGetDB( $index );
2546 $this->mActorId
= (int)$db->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2548 $this->setItemLoaded( 'actor' );
2551 return (int)$this->mActorId
;
2555 * Get the user's name escaped by underscores.
2556 * @return string Username escaped by underscores.
2558 public function getTitleKey() {
2559 return str_replace( ' ', '_', $this->getName() );
2563 * Check if the user has new messages.
2564 * @return bool True if the user has new messages
2566 public function getNewtalk() {
2569 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2570 if ( $this->mNewtalk
=== -1 ) {
2571 $this->mNewtalk
= false; # reset talk page status
2573 // Check memcached separately for anons, who have no
2574 // entire User object stored in there.
2575 if ( !$this->mId
) {
2576 global $wgDisableAnonTalk;
2577 if ( $wgDisableAnonTalk ) {
2578 // Anon newtalk disabled by configuration.
2579 $this->mNewtalk
= false;
2581 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2584 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2588 return (bool)$this->mNewtalk
;
2592 * Return the data needed to construct links for new talk page message
2593 * alerts. If there are new messages, this will return an associative array
2594 * with the following data:
2595 * wiki: The database name of the wiki
2596 * link: Root-relative link to the user's talk page
2597 * rev: The last talk page revision that the user has seen or null. This
2598 * is useful for building diff links.
2599 * If there are no new messages, it returns an empty array.
2600 * @note This function was designed to accomodate multiple talk pages, but
2601 * currently only returns a single link and revision.
2604 public function getNewMessageLinks() {
2605 // Avoid PHP 7.1 warning of passing $this by reference
2608 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
2612 if ( !$this->getNewtalk() ) {
2615 $utp = $this->getTalkPage();
2616 $dbr = wfGetDB( DB_REPLICA
);
2617 // Get the "last viewed rev" timestamp from the oldest message notification
2618 $timestamp = $dbr->selectField( 'user_newtalk',
2619 'MIN(user_last_timestamp)',
2620 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2622 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2625 'wiki' => WikiMap
::getWikiIdFromDbDomain( WikiMap
::getCurrentWikiDbDomain() ),
2626 'link' => $utp->getLocalURL(),
2633 * Get the revision ID for the last talk page revision viewed by the talk
2635 * @return int|null Revision ID or null
2637 public function getNewMessageRevisionId() {
2638 $newMessageRevisionId = null;
2639 $newMessageLinks = $this->getNewMessageLinks();
2641 // Note: getNewMessageLinks() never returns more than a single link
2642 // and it is always for the same wiki, but we double-check here in
2643 // case that changes some time in the future.
2644 if ( $newMessageLinks && count( $newMessageLinks ) === 1
2645 && WikiMap
::isCurrentWikiId( $newMessageLinks[0]['wiki'] )
2646 && $newMessageLinks[0]['rev']
2648 /** @var Revision $newMessageRevision */
2649 $newMessageRevision = $newMessageLinks[0]['rev'];
2650 $newMessageRevisionId = $newMessageRevision->getId();
2653 return $newMessageRevisionId;
2657 * Internal uncached check for new messages
2660 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2661 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2662 * @return bool True if the user has new messages
2664 protected function checkNewtalk( $field, $id ) {
2665 $dbr = wfGetDB( DB_REPLICA
);
2667 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2669 return $ok !== false;
2673 * Add or update the new messages flag
2674 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2675 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2676 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2677 * @return bool True if successful, false otherwise
2679 protected function updateNewtalk( $field, $id, $curRev = null ) {
2680 // Get timestamp of the talk page revision prior to the current one
2681 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2682 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2683 // Mark the user as having new messages since this revision
2684 $dbw = wfGetDB( DB_MASTER
);
2685 $dbw->insert( 'user_newtalk',
2686 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2689 if ( $dbw->affectedRows() ) {
2690 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2694 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2699 * Clear the new messages flag for the given user
2700 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2701 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2702 * @return bool True if successful, false otherwise
2704 protected function deleteNewtalk( $field, $id ) {
2705 $dbw = wfGetDB( DB_MASTER
);
2706 $dbw->delete( 'user_newtalk',
2709 if ( $dbw->affectedRows() ) {
2710 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2714 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2719 * Update the 'You have new messages!' status.
2720 * @param bool $val Whether the user has new messages
2721 * @param Revision|null $curRev New, as yet unseen revision of the user talk
2722 * page. Ignored if null or !$val.
2724 public function setNewtalk( $val, $curRev = null ) {
2725 if ( wfReadOnly() ) {
2730 $this->mNewtalk
= $val;
2732 if ( $this->isAnon() ) {
2734 $id = $this->getName();
2737 $id = $this->getId();
2741 $changed = $this->updateNewtalk( $field, $id, $curRev );
2743 $changed = $this->deleteNewtalk( $field, $id );
2747 $this->invalidateCache();
2752 * Generate a current or new-future timestamp to be stored in the
2753 * user_touched field when we update things.
2755 * @return string Timestamp in TS_MW format
2757 private function newTouchedTimestamp() {
2759 if ( $this->mTouched
) {
2760 $time = max( $time, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2763 return wfTimestamp( TS_MW
, $time );
2767 * Clear user data from memcached
2769 * Use after applying updates to the database; caller's
2770 * responsibility to update user_touched if appropriate.
2772 * Called implicitly from invalidateCache() and saveSettings().
2774 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2776 public function clearSharedCache( $mode = 'changed' ) {
2777 if ( !$this->getId() ) {
2781 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2782 $key = $this->getCacheKey( $cache );
2783 if ( $mode === 'refresh' ) {
2784 $cache->delete( $key, 1 );
2786 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2787 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2788 $lb->getConnection( DB_MASTER
)->onTransactionPreCommitOrIdle(
2789 function () use ( $cache, $key ) {
2790 $cache->delete( $key );
2795 $cache->delete( $key );
2801 * Immediately touch the user data cache for this account
2803 * Calls touch() and removes account data from memcached
2805 public function invalidateCache() {
2807 $this->clearSharedCache();
2811 * Update the "touched" timestamp for the user
2813 * This is useful on various login/logout events when making sure that
2814 * a browser or proxy that has multiple tenants does not suffer cache
2815 * pollution where the new user sees the old users content. The value
2816 * of getTouched() is checked when determining 304 vs 200 responses.
2817 * Unlike invalidateCache(), this preserves the User object cache and
2818 * avoids database writes.
2822 public function touch() {
2823 $id = $this->getId();
2825 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2826 $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
2827 $cache->touchCheckKey( $key );
2828 $this->mQuickTouched
= null;
2833 * Validate the cache for this account.
2834 * @param string $timestamp A timestamp in TS_MW format
2837 public function validateCache( $timestamp ) {
2838 return ( $timestamp >= $this->getTouched() );
2842 * Get the user touched timestamp
2844 * Use this value only to validate caches via inequalities
2845 * such as in the case of HTTP If-Modified-Since response logic
2847 * @return string TS_MW Timestamp
2849 public function getTouched() {
2853 if ( $this->mQuickTouched
=== null ) {
2854 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2855 $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId
);
2857 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2860 return max( $this->mTouched
, $this->mQuickTouched
);
2863 return $this->mTouched
;
2867 * Get the user_touched timestamp field (time of last DB updates)
2868 * @return string TS_MW Timestamp
2871 public function getDBTouched() {
2874 return $this->mTouched
;
2878 * Set the password and reset the random token.
2879 * Calls through to authentication plugin if necessary;
2880 * will have no effect if the auth plugin refuses to
2881 * pass the change through or if the legal password
2884 * As a special case, setting the password to null
2885 * wipes it, so the account cannot be logged in until
2886 * a new password is set, for instance via e-mail.
2888 * @deprecated since 1.27, use AuthManager instead
2889 * @param string $str New password to set
2890 * @throws PasswordError On failure
2893 public function setPassword( $str ) {
2894 wfDeprecated( __METHOD__
, '1.27' );
2895 return $this->setPasswordInternal( $str );
2899 * Set the password and reset the random token unconditionally.
2901 * @deprecated since 1.27, use AuthManager instead
2902 * @param string|null $str New password to set or null to set an invalid
2903 * password hash meaning that the user will not be able to log in
2904 * through the web interface.
2906 public function setInternalPassword( $str ) {
2907 wfDeprecated( __METHOD__
, '1.27' );
2908 $this->setPasswordInternal( $str );
2912 * Actually set the password and such
2913 * @since 1.27 cannot set a password for a user not in the database
2914 * @param string|null $str New password to set or null to set an invalid
2915 * password hash meaning that the user will not be able to log in
2916 * through the web interface.
2917 * @return bool Success
2919 private function setPasswordInternal( $str ) {
2920 $manager = AuthManager
::singleton();
2922 // If the user doesn't exist yet, fail
2923 if ( !$manager->userExists( $this->getName() ) ) {
2924 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2927 $status = $this->changeAuthenticationData( [
2928 'username' => $this->getName(),
2932 if ( !$status->isGood() ) {
2933 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2934 ->info( __METHOD__
. ': Password change rejected: '
2935 . $status->getWikiText( null, null, 'en' ) );
2939 $this->setOption( 'watchlisttoken', false );
2940 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2946 * Changes credentials of the user.
2948 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2949 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2950 * e.g. when no provider handled the change.
2952 * @param array $data A set of authentication data in fieldname => value format. This is the
2953 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2957 public function changeAuthenticationData( array $data ) {
2958 $manager = AuthManager
::singleton();
2959 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2960 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2962 $status = Status
::newGood( 'ignored' );
2963 foreach ( $reqs as $req ) {
2964 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2966 if ( $status->getValue() === 'ignored' ) {
2967 $status->warning( 'authenticationdatachange-ignored' );
2970 if ( $status->isGood() ) {
2971 foreach ( $reqs as $req ) {
2972 $manager->changeAuthenticationData( $req );
2979 * Get the user's current token.
2980 * @param bool $forceCreation Force the generation of a new token if the
2981 * user doesn't have one (default=true for backwards compatibility).
2982 * @return string|null Token
2984 public function getToken( $forceCreation = true ) {
2985 global $wgAuthenticationTokenVersion;
2988 if ( !$this->mToken
&& $forceCreation ) {
2992 if ( !$this->mToken
) {
2993 // The user doesn't have a token, return null to indicate that.
2997 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
2998 // We return a random value here so existing token checks are very
3000 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3003 if ( $wgAuthenticationTokenVersion === null ) {
3004 // $wgAuthenticationTokenVersion not in use, so return the raw secret
3005 return $this->mToken
;
3008 // $wgAuthenticationTokenVersion in use, so hmac it.
3009 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
3011 // The raw hash can be overly long. Shorten it up.
3012 $len = max( 32, self
::TOKEN_LENGTH
);
3013 if ( strlen( $ret ) < $len ) {
3014 // Should never happen, even md5 is 128 bits
3015 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
3018 return substr( $ret, -$len );
3022 * Set the random token (used for persistent authentication)
3023 * Called from loadDefaults() among other places.
3025 * @param string|bool $token If specified, set the token to this value
3027 public function setToken( $token = false ) {
3029 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
3030 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3031 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
3032 } elseif ( !$token ) {
3033 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3035 $this->mToken
= $token;
3040 * Set the password for a password reminder or new account email
3042 * @deprecated Removed in 1.27. Use PasswordReset instead.
3043 * @param string $str New password to set or null to set an invalid
3044 * password hash meaning that the user will not be able to use it
3045 * @param bool $throttle If true, reset the throttle timestamp to the present
3047 public function setNewpassword( $str, $throttle = true ) {
3048 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
3052 * Get the user's e-mail address
3053 * @return string User's email address
3055 public function getEmail() {
3057 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
3058 return $this->mEmail
;
3062 * Get the timestamp of the user's e-mail authentication
3063 * @return string TS_MW timestamp
3065 public function getEmailAuthenticationTimestamp() {
3067 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
3068 return $this->mEmailAuthenticated
;
3072 * Set the user's e-mail address
3073 * @param string $str New e-mail address
3075 public function setEmail( $str ) {
3077 if ( $str == $this->mEmail
) {
3080 $this->invalidateEmail();
3081 $this->mEmail
= $str;
3082 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
3086 * Set the user's e-mail address and a confirmation mail if needed.
3089 * @param string $str New e-mail address
3092 public function setEmailWithConfirmation( $str ) {
3093 global $wgEnableEmail, $wgEmailAuthentication;
3095 if ( !$wgEnableEmail ) {
3096 return Status
::newFatal( 'emaildisabled' );
3099 $oldaddr = $this->getEmail();
3100 if ( $str === $oldaddr ) {
3101 return Status
::newGood( true );
3104 $type = $oldaddr != '' ?
'changed' : 'set';
3105 $notificationResult = null;
3107 if ( $wgEmailAuthentication && $type === 'changed' ) {
3108 // Send the user an email notifying the user of the change in registered
3109 // email address on their previous email address
3110 $change = $str != '' ?
'changed' : 'removed';
3111 $notificationResult = $this->sendMail(
3112 wfMessage( 'notificationemail_subject_' . $change )->text(),
3113 wfMessage( 'notificationemail_body_' . $change,
3114 $this->getRequest()->getIP(),
3120 $this->setEmail( $str );
3122 if ( $str !== '' && $wgEmailAuthentication ) {
3123 // Send a confirmation request to the new address if needed
3124 $result = $this->sendConfirmationMail( $type );
3126 if ( $notificationResult !== null ) {
3127 $result->merge( $notificationResult );
3130 if ( $result->isGood() ) {
3131 // Say to the caller that a confirmation and notification mail has been sent
3132 $result->value
= 'eauth';
3135 $result = Status
::newGood( true );
3142 * Get the user's real name
3143 * @return string User's real name
3145 public function getRealName() {
3146 if ( !$this->isItemLoaded( 'realname' ) ) {
3150 return $this->mRealName
;
3154 * Set the user's real name
3155 * @param string $str New real name
3157 public function setRealName( $str ) {
3159 $this->mRealName
= $str;
3163 * Get the user's current setting for a given option.
3165 * @param string $oname The option to check
3166 * @param string|array|null $defaultOverride A default value returned if the option does not exist
3167 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
3168 * @return string|array|int|null User's current value for the option
3169 * @see getBoolOption()
3170 * @see getIntOption()
3172 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
3173 global $wgHiddenPrefs;
3174 $this->loadOptions();
3176 # We want 'disabled' preferences to always behave as the default value for
3177 # users, even if they have set the option explicitly in their settings (ie they
3178 # set it, and then it was disabled removing their ability to change it). But
3179 # we don't want to erase the preferences in the database in case the preference
3180 # is re-enabled again. So don't touch $mOptions, just override the returned value
3181 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
3182 return self
::getDefaultOption( $oname );
3185 if ( array_key_exists( $oname, $this->mOptions
) ) {
3186 return $this->mOptions
[$oname];
3189 return $defaultOverride;
3193 * Get all user's options
3195 * @param int $flags Bitwise combination of:
3196 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
3197 * to the default value. (Since 1.25)
3200 public function getOptions( $flags = 0 ) {
3201 global $wgHiddenPrefs;
3202 $this->loadOptions();
3203 $options = $this->mOptions
;
3205 # We want 'disabled' preferences to always behave as the default value for
3206 # users, even if they have set the option explicitly in their settings (ie they
3207 # set it, and then it was disabled removing their ability to change it). But
3208 # we don't want to erase the preferences in the database in case the preference
3209 # is re-enabled again. So don't touch $mOptions, just override the returned value
3210 foreach ( $wgHiddenPrefs as $pref ) {
3211 $default = self
::getDefaultOption( $pref );
3212 if ( $default !== null ) {
3213 $options[$pref] = $default;
3217 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
3218 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
3225 * Get the user's current setting for a given option, as a boolean value.
3227 * @param string $oname The option to check
3228 * @return bool User's current value for the option
3231 public function getBoolOption( $oname ) {
3232 return (bool)$this->getOption( $oname );
3236 * Get the user's current setting for a given option, as an integer value.
3238 * @param string $oname The option to check
3239 * @param int $defaultOverride A default value returned if the option does not exist
3240 * @return int User's current value for the option
3243 public function getIntOption( $oname, $defaultOverride = 0 ) {
3244 $val = $this->getOption( $oname );
3246 $val = $defaultOverride;
3248 return intval( $val );
3252 * Set the given option for a user.
3254 * You need to call saveSettings() to actually write to the database.
3256 * @param string $oname The option to set
3257 * @param mixed $val New value to set
3259 public function setOption( $oname, $val ) {
3260 $this->loadOptions();
3262 // Explicitly NULL values should refer to defaults
3263 if ( is_null( $val ) ) {
3264 $val = self
::getDefaultOption( $oname );
3267 $this->mOptions
[$oname] = $val;
3271 * Get a token stored in the preferences (like the watchlist one),
3272 * resetting it if it's empty (and saving changes).
3274 * @param string $oname The option name to retrieve the token from
3275 * @return string|bool User's current value for the option, or false if this option is disabled.
3276 * @see resetTokenFromOption()
3278 * @deprecated since 1.26 Applications should use the OAuth extension
3280 public function getTokenFromOption( $oname ) {
3281 global $wgHiddenPrefs;
3283 $id = $this->getId();
3284 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
3288 $token = $this->getOption( $oname );
3290 // Default to a value based on the user token to avoid space
3291 // wasted on storing tokens for all users. When this option
3292 // is set manually by the user, only then is it stored.
3293 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
3300 * Reset a token stored in the preferences (like the watchlist one).
3301 * *Does not* save user's preferences (similarly to setOption()).
3303 * @param string $oname The option name to reset the token in
3304 * @return string|bool New token value, or false if this option is disabled.
3305 * @see getTokenFromOption()
3308 public function resetTokenFromOption( $oname ) {
3309 global $wgHiddenPrefs;
3310 if ( in_array( $oname, $wgHiddenPrefs ) ) {
3314 $token = MWCryptRand
::generateHex( 40 );
3315 $this->setOption( $oname, $token );
3320 * Return a list of the types of user options currently returned by
3321 * User::getOptionKinds().
3323 * Currently, the option kinds are:
3324 * - 'registered' - preferences which are registered in core MediaWiki or
3325 * by extensions using the UserGetDefaultOptions hook.
3326 * - 'registered-multiselect' - as above, using the 'multiselect' type.
3327 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
3328 * - 'userjs' - preferences with names starting with 'userjs-', intended to
3329 * be used by user scripts.
3330 * - 'special' - "preferences" that are not accessible via User::getOptions
3331 * or User::setOptions.
3332 * - 'unused' - preferences about which MediaWiki doesn't know anything.
3333 * These are usually legacy options, removed in newer versions.
3335 * The API (and possibly others) use this function to determine the possible
3336 * option types for validation purposes, so make sure to update this when a
3337 * new option kind is added.
3339 * @see User::getOptionKinds
3340 * @return array Option kinds
3342 public static function listOptionKinds() {
3345 'registered-multiselect',
3346 'registered-checkmatrix',
3354 * Return an associative array mapping preferences keys to the kind of a preference they're
3355 * used for. Different kinds are handled differently when setting or reading preferences.
3357 * See User::listOptionKinds for the list of valid option types that can be provided.
3359 * @see User::listOptionKinds
3360 * @param IContextSource $context
3361 * @param array|null $options Assoc. array with options keys to check as keys.
3362 * Defaults to $this->mOptions.
3363 * @return array The key => kind mapping data
3365 public function getOptionKinds( IContextSource
$context, $options = null ) {
3366 $this->loadOptions();
3367 if ( $options === null ) {
3368 $options = $this->mOptions
;
3371 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
3372 $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
3375 // Pull out the "special" options, so they don't get converted as
3376 // multiselect or checkmatrix.
3377 $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
3378 foreach ( $specialOptions as $name => $value ) {
3379 unset( $prefs[$name] );
3382 // Multiselect and checkmatrix options are stored in the database with
3383 // one key per option, each having a boolean value. Extract those keys.
3384 $multiselectOptions = [];
3385 foreach ( $prefs as $name => $info ) {
3386 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3387 ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField
::class ) ) {
3388 $opts = HTMLFormField
::flattenOptions( $info['options'] );
3389 $prefix = $info['prefix'] ??
$name;
3391 foreach ( $opts as $value ) {
3392 $multiselectOptions["$prefix$value"] = true;
3395 unset( $prefs[$name] );
3398 $checkmatrixOptions = [];
3399 foreach ( $prefs as $name => $info ) {
3400 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3401 ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix
::class ) ) {
3402 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3403 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3404 $prefix = $info['prefix'] ??
$name;
3406 foreach ( $columns as $column ) {
3407 foreach ( $rows as $row ) {
3408 $checkmatrixOptions["$prefix$column-$row"] = true;
3412 unset( $prefs[$name] );
3416 // $value is ignored
3417 foreach ( $options as $key => $value ) {
3418 if ( isset( $prefs[$key] ) ) {
3419 $mapping[$key] = 'registered';
3420 } elseif ( isset( $multiselectOptions[$key] ) ) {
3421 $mapping[$key] = 'registered-multiselect';
3422 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3423 $mapping[$key] = 'registered-checkmatrix';
3424 } elseif ( isset( $specialOptions[$key] ) ) {
3425 $mapping[$key] = 'special';
3426 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3427 $mapping[$key] = 'userjs';
3429 $mapping[$key] = 'unused';
3437 * Reset certain (or all) options to the site defaults
3439 * The optional parameter determines which kinds of preferences will be reset.
3440 * Supported values are everything that can be reported by getOptionKinds()
3441 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3443 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3444 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3445 * for backwards-compatibility.
3446 * @param IContextSource|null $context Context source used when $resetKinds
3447 * does not contain 'all', passed to getOptionKinds().
3448 * Defaults to RequestContext::getMain() when null.
3450 public function resetOptions(
3451 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3452 IContextSource
$context = null
3455 $defaultOptions = self
::getDefaultOptions();
3457 if ( !is_array( $resetKinds ) ) {
3458 $resetKinds = [ $resetKinds ];
3461 if ( in_array( 'all', $resetKinds ) ) {
3462 $newOptions = $defaultOptions;
3464 if ( $context === null ) {
3465 $context = RequestContext
::getMain();
3468 $optionKinds = $this->getOptionKinds( $context );
3469 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3472 // Use default values for the options that should be deleted, and
3473 // copy old values for the ones that shouldn't.
3474 foreach ( $this->mOptions
as $key => $value ) {
3475 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3476 if ( array_key_exists( $key, $defaultOptions ) ) {
3477 $newOptions[$key] = $defaultOptions[$key];
3480 $newOptions[$key] = $value;
3485 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3487 $this->mOptions
= $newOptions;
3488 $this->mOptionsLoaded
= true;
3492 * Get the user's preferred date format.
3493 * @return string User's preferred date format
3495 public function getDatePreference() {
3496 // Important migration for old data rows
3497 if ( is_null( $this->mDatePreference
) ) {
3499 $value = $this->getOption( 'date' );
3500 $map = $wgLang->getDatePreferenceMigrationMap();
3501 if ( isset( $map[$value] ) ) {
3502 $value = $map[$value];
3504 $this->mDatePreference
= $value;
3506 return $this->mDatePreference
;
3510 * Determine based on the wiki configuration and the user's options,
3511 * whether this user must be over HTTPS no matter what.
3515 public function requiresHTTPS() {
3516 global $wgSecureLogin;
3517 if ( !$wgSecureLogin ) {
3521 $https = $this->getBoolOption( 'prefershttps' );
3522 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3524 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3531 * Get the user preferred stub threshold
3535 public function getStubThreshold() {
3536 global $wgMaxArticleSize; # Maximum article size, in Kb
3537 $threshold = $this->getIntOption( 'stubthreshold' );
3538 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3539 // If they have set an impossible value, disable the preference
3540 // so we can use the parser cache again.
3547 * Get the permissions this user has.
3548 * @return string[] permission names
3550 public function getRights() {
3551 if ( is_null( $this->mRights
) ) {
3552 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3553 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3555 // Deny any rights denied by the user's session, unless this
3556 // endpoint has no sessions.
3557 if ( !defined( 'MW_NO_SESSION' ) ) {
3558 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3559 if ( $allowedRights !== null ) {
3560 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3564 Hooks
::run( 'UserGetRightsRemove', [ $this, &$this->mRights
] );
3565 // Force reindexation of rights when a hook has unset one of them
3566 $this->mRights
= array_values( array_unique( $this->mRights
) );
3568 // If block disables login, we should also remove any
3569 // extra rights blocked users might have, in case the
3570 // blocked user has a pre-existing session (T129738).
3571 // This is checked here for cases where people only call
3572 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3573 // to give a better error message in the common case.
3574 $config = RequestContext
::getMain()->getConfig();
3576 $this->isLoggedIn() &&
3577 $config->get( 'BlockDisablesLogin' ) &&
3581 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3584 return $this->mRights
;
3588 * Get the list of explicit group memberships this user has.
3589 * The implicit * and user groups are not included.
3591 * @return string[] Array of internal group names (sorted since 1.33)
3593 public function getGroups() {
3595 $this->loadGroups();
3596 return array_keys( $this->mGroupMemberships
);
3600 * Get the list of explicit group memberships this user has, stored as
3601 * UserGroupMembership objects. Implicit groups are not included.
3603 * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
3606 public function getGroupMemberships() {
3608 $this->loadGroups();
3609 return $this->mGroupMemberships
;
3613 * Get the list of implicit group memberships this user has.
3614 * This includes all explicit groups, plus 'user' if logged in,
3615 * '*' for all accounts, and autopromoted groups
3616 * @param bool $recache Whether to avoid the cache
3617 * @return array Array of String internal group names
3619 public function getEffectiveGroups( $recache = false ) {
3620 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3621 $this->mEffectiveGroups
= array_unique( array_merge(
3622 $this->getGroups(), // explicit groups
3623 $this->getAutomaticGroups( $recache ) // implicit groups
3625 // Avoid PHP 7.1 warning of passing $this by reference
3627 // Hook for additional groups
3628 Hooks
::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups
] );
3629 // Force reindexation of groups when a hook has unset one of them
3630 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3632 return $this->mEffectiveGroups
;
3636 * Get the list of implicit group memberships this user has.
3637 * This includes 'user' if logged in, '*' for all accounts,
3638 * and autopromoted groups
3639 * @param bool $recache Whether to avoid the cache
3640 * @return array Array of String internal group names
3642 public function getAutomaticGroups( $recache = false ) {
3643 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3644 $this->mImplicitGroups
= [ '*' ];
3645 if ( $this->getId() ) {
3646 $this->mImplicitGroups
[] = 'user';
3648 $this->mImplicitGroups
= array_unique( array_merge(
3649 $this->mImplicitGroups
,
3650 Autopromote
::getAutopromoteGroups( $this )
3654 // Assure data consistency with rights/groups,
3655 // as getEffectiveGroups() depends on this function
3656 $this->mEffectiveGroups
= null;
3659 return $this->mImplicitGroups
;
3663 * Returns the groups the user has belonged to.
3665 * The user may still belong to the returned groups. Compare with getGroups().
3667 * The function will not return groups the user had belonged to before MW 1.17
3669 * @return array Names of the groups the user has belonged to.
3671 public function getFormerGroups() {
3674 if ( is_null( $this->mFormerGroups
) ) {
3675 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3676 ?
wfGetDB( DB_MASTER
)
3677 : wfGetDB( DB_REPLICA
);
3678 $res = $db->select( 'user_former_groups',
3680 [ 'ufg_user' => $this->mId
],
3682 $this->mFormerGroups
= [];
3683 foreach ( $res as $row ) {
3684 $this->mFormerGroups
[] = $row->ufg_group
;
3688 return $this->mFormerGroups
;
3692 * Get the user's edit count.
3693 * @return int|null Null for anonymous users
3695 public function getEditCount() {
3696 if ( !$this->getId() ) {
3700 if ( $this->mEditCount
=== null ) {
3701 /* Populate the count, if it has not been populated yet */
3702 $dbr = wfGetDB( DB_REPLICA
);
3703 // check if the user_editcount field has been initialized
3704 $count = $dbr->selectField(
3705 'user', 'user_editcount',
3706 [ 'user_id' => $this->mId
],
3710 if ( $count === null ) {
3711 // it has not been initialized. do so.
3712 $count = $this->initEditCountInternal();
3714 $this->mEditCount
= $count;
3716 return (int)$this->mEditCount
;
3720 * Add the user to the given group. This takes immediate effect.
3721 * If the user is already in the group, the expiry time will be updated to the new
3722 * expiry time. (If $expiry is omitted or null, the membership will be altered to
3725 * @param string $group Name of the group to add
3726 * @param string|null $expiry Optional expiry timestamp in any format acceptable to
3727 * wfTimestamp(), or null if the group assignment should not expire
3730 public function addGroup( $group, $expiry = null ) {
3732 $this->loadGroups();
3735 $expiry = wfTimestamp( TS_MW
, $expiry );
3738 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
3742 // create the new UserGroupMembership and put it in the DB
3743 $ugm = new UserGroupMembership( $this->mId
, $group, $expiry );
3744 if ( !$ugm->insert( true ) ) {
3748 $this->mGroupMemberships
[$group] = $ugm;
3750 // Refresh the groups caches, and clear the rights cache so it will be
3751 // refreshed on the next call to $this->getRights().
3752 $this->getEffectiveGroups( true );
3753 $this->mRights
= null;
3755 $this->invalidateCache();
3761 * Remove the user from the given group.
3762 * This takes immediate effect.
3763 * @param string $group Name of the group to remove
3766 public function removeGroup( $group ) {
3769 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3773 $ugm = UserGroupMembership
::getMembership( $this->mId
, $group );
3774 // delete the membership entry
3775 if ( !$ugm ||
!$ugm->delete() ) {
3779 $this->loadGroups();
3780 unset( $this->mGroupMemberships
[$group] );
3782 // Refresh the groups caches, and clear the rights cache so it will be
3783 // refreshed on the next call to $this->getRights().
3784 $this->getEffectiveGroups( true );
3785 $this->mRights
= null;
3787 $this->invalidateCache();
3793 * Get whether the user is logged in
3796 public function isLoggedIn() {
3797 return $this->getId() != 0;
3801 * Get whether the user is anonymous
3804 public function isAnon() {
3805 return !$this->isLoggedIn();
3809 * @return bool Whether this user is flagged as being a bot role account
3812 public function isBot() {
3813 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3818 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3824 * Check if user is allowed to access a feature / make an action
3826 * @param string $permissions,... Permissions to test
3827 * @return bool True if user is allowed to perform *any* of the given actions
3829 public function isAllowedAny() {
3830 $permissions = func_get_args();
3831 foreach ( $permissions as $permission ) {
3832 if ( $this->isAllowed( $permission ) ) {
3841 * @param string $permissions,... Permissions to test
3842 * @return bool True if the user is allowed to perform *all* of the given actions
3844 public function isAllowedAll() {
3845 $permissions = func_get_args();
3846 foreach ( $permissions as $permission ) {
3847 if ( !$this->isAllowed( $permission ) ) {
3855 * Internal mechanics of testing a permission
3856 * @param string $action
3859 public function isAllowed( $action = '' ) {
3860 if ( $action === '' ) {
3861 return true; // In the spirit of DWIM
3863 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3864 // by misconfiguration: 0 == 'foo'
3865 return in_array( $action, $this->getRights(), true );
3869 * Check whether to enable recent changes patrol features for this user
3870 * @return bool True or false
3872 public function useRCPatrol() {
3873 global $wgUseRCPatrol;
3874 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3878 * Check whether to enable new pages patrol features for this user
3879 * @return bool True or false
3881 public function useNPPatrol() {
3882 global $wgUseRCPatrol, $wgUseNPPatrol;
3884 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3885 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3890 * Check whether to enable new files patrol features for this user
3891 * @return bool True or false
3893 public function useFilePatrol() {
3894 global $wgUseRCPatrol, $wgUseFilePatrol;
3896 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3897 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3902 * Get the WebRequest object to use with this object
3904 * @return WebRequest
3906 public function getRequest() {
3907 if ( $this->mRequest
) {
3908 return $this->mRequest
;
3916 * Check the watched status of an article.
3917 * @since 1.22 $checkRights parameter added
3918 * @param Title $title Title of the article to look at
3919 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3920 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3923 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3924 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3925 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3932 * @since 1.22 $checkRights parameter added
3933 * @param Title $title Title of the article to look at
3934 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3935 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3937 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3938 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3939 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3941 [ $title->getSubjectPage(), $title->getTalkPage() ]
3944 $this->invalidateCache();
3948 * Stop watching an article.
3949 * @since 1.22 $checkRights parameter added
3950 * @param Title $title Title of the article to look at
3951 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3952 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3954 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3955 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3956 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3957 $store->removeWatch( $this, $title->getSubjectPage() );
3958 $store->removeWatch( $this, $title->getTalkPage() );
3960 $this->invalidateCache();
3964 * Clear the user's notification timestamp for the given title.
3965 * If e-notif e-mails are on, they will receive notification mails on
3966 * the next change of the page if it's watched etc.
3967 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3968 * @param Title &$title Title of the article to look at
3969 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3971 public function clearNotification( &$title, $oldid = 0 ) {
3972 global $wgUseEnotif, $wgShowUpdatedMarker;
3974 // Do nothing if the database is locked to writes
3975 if ( wfReadOnly() ) {
3979 // Do nothing if not allowed to edit the watchlist
3980 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3984 // If we're working on user's talk page, we should update the talk page message indicator
3985 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3986 // Avoid PHP 7.1 warning of passing $this by reference
3988 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
3992 // Try to update the DB post-send and only if needed...
3993 DeferredUpdates
::addCallableUpdate( function () use ( $title, $oldid ) {
3994 if ( !$this->getNewtalk() ) {
3995 return; // no notifications to clear
3998 // Delete the last notifications (they stack up)
3999 $this->setNewtalk( false );
4001 // If there is a new, unseen, revision, use its timestamp
4003 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
4006 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
4011 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4015 if ( $this->isAnon() ) {
4016 // Nothing else to do...
4020 // Only update the timestamp if the page is being watched.
4021 // The query to find out if it is watched is cached both in memcached and per-invocation,
4022 // and when it does have to be executed, it can be on a replica DB
4023 // If this is the user's newtalk page, we always update the timestamp
4025 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
4029 MediaWikiServices
::getInstance()->getWatchedItemStore()
4030 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
4034 * Resets all of the given user's page-change notification timestamps.
4035 * If e-notif e-mails are on, they will receive notification mails on
4036 * the next change of any watched page.
4037 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
4039 public function clearAllNotifications() {
4040 global $wgUseEnotif, $wgShowUpdatedMarker;
4041 // Do nothing if not allowed to edit the watchlist
4042 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
4046 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4047 $this->setNewtalk( false );
4051 $id = $this->getId();
4056 $watchedItemStore = MediaWikiServices
::getInstance()->getWatchedItemStore();
4057 $watchedItemStore->resetAllNotificationTimestampsForUser( $this );
4059 // We also need to clear here the "you have new message" notification for the own
4060 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
4064 * Compute experienced level based on edit count and registration date.
4066 * @return string 'newcomer', 'learner', or 'experienced'
4068 public function getExperienceLevel() {
4069 global $wgLearnerEdits,
4070 $wgExperiencedUserEdits,
4071 $wgLearnerMemberSince,
4072 $wgExperiencedUserMemberSince;
4074 if ( $this->isAnon() ) {
4078 $editCount = $this->getEditCount();
4079 $registration = $this->getRegistration();
4081 $learnerRegistration = wfTimestamp( TS_MW
, $now - $wgLearnerMemberSince * 86400 );
4082 $experiencedRegistration = wfTimestamp( TS_MW
, $now - $wgExperiencedUserMemberSince * 86400 );
4084 if ( $editCount < $wgLearnerEdits ||
4085 $registration > $learnerRegistration ) {
4089 if ( $editCount > $wgExperiencedUserEdits &&
4090 $registration <= $experiencedRegistration
4092 return 'experienced';
4099 * Persist this user's session (e.g. set cookies)
4101 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
4103 * @param bool|null $secure Whether to force secure/insecure cookies or use default
4104 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
4106 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
4108 if ( $this->mId
== 0 ) {
4112 $session = $this->getRequest()->getSession();
4113 if ( $request && $session->getRequest() !== $request ) {
4114 $session = $session->sessionWithRequest( $request );
4116 $delay = $session->delaySave();
4118 if ( !$session->getUser()->equals( $this ) ) {
4119 if ( !$session->canSetUser() ) {
4120 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4121 ->warning( __METHOD__
.
4122 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
4126 $session->setUser( $this );
4129 $session->setRememberUser( $rememberMe );
4130 if ( $secure !== null ) {
4131 $session->setForceHTTPS( $secure );
4134 $session->persist();
4136 ScopedCallback
::consume( $delay );
4140 * Log this user out.
4142 public function logout() {
4143 // Avoid PHP 7.1 warning of passing $this by reference
4145 if ( Hooks
::run( 'UserLogout', [ &$user ] ) ) {
4151 * Clear the user's session, and reset the instance cache.
4154 public function doLogout() {
4155 $session = $this->getRequest()->getSession();
4156 if ( !$session->canSetUser() ) {
4157 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4158 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
4159 $error = 'immutable';
4160 } elseif ( !$session->getUser()->equals( $this ) ) {
4161 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4162 ->warning( __METHOD__
.
4163 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
4165 // But we still may as well make this user object anon
4166 $this->clearInstanceCache( 'defaults' );
4167 $error = 'wronguser';
4169 $this->clearInstanceCache( 'defaults' );
4170 $delay = $session->delaySave();
4171 $session->unpersist(); // Clear cookies (T127436)
4172 $session->setLoggedOutTimestamp( time() );
4173 $session->setUser( new User
);
4174 $session->set( 'wsUserID', 0 ); // Other code expects this
4175 $session->resetAllTokens();
4176 ScopedCallback
::consume( $delay );
4179 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
4180 'event' => 'logout',
4181 'successful' => $error === false,
4182 'status' => $error ?
: 'success',
4187 * Save this user's settings into the database.
4188 * @todo Only rarely do all these fields need to be set!
4190 public function saveSettings() {
4191 if ( wfReadOnly() ) {
4192 // @TODO: caller should deal with this instead!
4193 // This should really just be an exception.
4194 MWExceptionHandler
::logException( new DBExpectedError(
4196 "Could not update user with ID '{$this->mId}'; DB is read-only."
4202 if ( $this->mId
== 0 ) {
4206 // Get a new user_touched that is higher than the old one.
4207 // This will be used for a CAS check as a last-resort safety
4208 // check against race conditions and replica DB lag.
4209 $newTouched = $this->newTouchedTimestamp();
4211 $dbw = wfGetDB( DB_MASTER
);
4212 $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $newTouched ) {
4213 global $wgActorTableSchemaMigrationStage;
4215 $dbw->update( 'user',
4217 'user_name' => $this->mName
,
4218 'user_real_name' => $this->mRealName
,
4219 'user_email' => $this->mEmail
,
4220 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4221 'user_touched' => $dbw->timestamp( $newTouched ),
4222 'user_token' => strval( $this->mToken
),
4223 'user_email_token' => $this->mEmailToken
,
4224 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
4225 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
4226 'user_id' => $this->mId
,
4230 if ( !$dbw->affectedRows() ) {
4231 // Maybe the problem was a missed cache update; clear it to be safe
4232 $this->clearSharedCache( 'refresh' );
4233 // User was changed in the meantime or loaded with stale data
4234 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
4235 LoggerFactory
::getInstance( 'preferences' )->warning(
4236 "CAS update failed on user_touched for user ID '{user_id}' ({db_flag} read)",
4237 [ 'user_id' => $this->mId
, 'db_flag' => $from ]
4239 throw new MWException( "CAS update failed on user_touched. " .
4240 "The version of the user to be saved is older than the current version."
4244 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4247 [ 'actor_name' => $this->mName
],
4248 [ 'actor_user' => $this->mId
],
4254 $this->mTouched
= $newTouched;
4255 $this->saveOptions();
4257 Hooks
::run( 'UserSaveSettings', [ $this ] );
4258 $this->clearSharedCache();
4259 $this->getUserPage()->purgeSquid();
4263 * If only this user's username is known, and it exists, return the user ID.
4265 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
4268 public function idForName( $flags = 0 ) {
4269 $s = trim( $this->getName() );
4274 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
4275 ?
wfGetDB( DB_MASTER
)
4276 : wfGetDB( DB_REPLICA
);
4278 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
4279 ?
[ 'LOCK IN SHARE MODE' ]
4282 $id = $db->selectField( 'user',
4283 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
4289 * Add a user to the database, return the user object
4291 * @param string $name Username to add
4292 * @param array $params Array of Strings Non-default parameters to save to
4293 * the database as user_* fields:
4294 * - email: The user's email address.
4295 * - email_authenticated: The email authentication timestamp.
4296 * - real_name: The user's real name.
4297 * - options: An associative array of non-default options.
4298 * - token: Random authentication token. Do not set.
4299 * - registration: Registration timestamp. Do not set.
4301 * @return User|null User object, or null if the username already exists.
4303 public static function createNew( $name, $params = [] ) {
4304 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
4305 if ( isset( $params[$field] ) ) {
4306 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
4307 unset( $params[$field] );
4313 $user->setToken(); // init token
4314 if ( isset( $params['options'] ) ) {
4315 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
4316 unset( $params['options'] );
4318 $dbw = wfGetDB( DB_MASTER
);
4320 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4323 'user_name' => $name,
4324 'user_password' => $noPass,
4325 'user_newpassword' => $noPass,
4326 'user_email' => $user->mEmail
,
4327 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
4328 'user_real_name' => $user->mRealName
,
4329 'user_token' => strval( $user->mToken
),
4330 'user_registration' => $dbw->timestamp( $user->mRegistration
),
4331 'user_editcount' => 0,
4332 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4334 foreach ( $params as $name => $value ) {
4335 $fields["user_$name"] = $value;
4338 return $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $fields ) {
4339 $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
4340 if ( $dbw->affectedRows() ) {
4341 $newUser = self
::newFromId( $dbw->insertId() );
4342 $newUser->mName
= $fields['user_name'];
4343 $newUser->updateActorId( $dbw );
4344 // Load the user from master to avoid replica lag
4345 $newUser->load( self
::READ_LATEST
);
4354 * Add this existing user object to the database. If the user already
4355 * exists, a fatal status object is returned, and the user object is
4356 * initialised with the data from the database.
4358 * Previously, this function generated a DB error due to a key conflict
4359 * if the user already existed. Many extension callers use this function
4360 * in code along the lines of:
4362 * $user = User::newFromName( $name );
4363 * if ( !$user->isLoggedIn() ) {
4364 * $user->addToDatabase();
4366 * // do something with $user...
4368 * However, this was vulnerable to a race condition (T18020). By
4369 * initialising the user object if the user exists, we aim to support this
4370 * calling sequence as far as possible.
4372 * Note that if the user exists, this function will acquire a write lock,
4373 * so it is still advisable to make the call conditional on isLoggedIn(),
4374 * and to commit the transaction after calling.
4376 * @throws MWException
4379 public function addToDatabase() {
4381 if ( !$this->mToken
) {
4382 $this->setToken(); // init token
4385 if ( !is_string( $this->mName
) ) {
4386 throw new RuntimeException( "User name field is not set." );
4389 $this->mTouched
= $this->newTouchedTimestamp();
4391 $dbw = wfGetDB( DB_MASTER
);
4392 $status = $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) {
4393 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4394 $dbw->insert( 'user',
4396 'user_name' => $this->mName
,
4397 'user_password' => $noPass,
4398 'user_newpassword' => $noPass,
4399 'user_email' => $this->mEmail
,
4400 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4401 'user_real_name' => $this->mRealName
,
4402 'user_token' => strval( $this->mToken
),
4403 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4404 'user_editcount' => 0,
4405 'user_touched' => $dbw->timestamp( $this->mTouched
),
4409 if ( !$dbw->affectedRows() ) {
4410 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4411 $this->mId
= $dbw->selectField(
4414 [ 'user_name' => $this->mName
],
4416 [ 'LOCK IN SHARE MODE' ]
4419 if ( $this->mId
&& $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4423 throw new MWException( $fname . ": hit a key conflict attempting " .
4424 "to insert user '{$this->mName}' row, but it was not present in select!" );
4426 return Status
::newFatal( 'userexists' );
4428 $this->mId
= $dbw->insertId();
4429 self
::$idCacheByName[$this->mName
] = $this->mId
;
4430 $this->updateActorId( $dbw );
4432 return Status
::newGood();
4434 if ( !$status->isGood() ) {
4438 // Clear instance cache other than user table data and actor, which is already accurate
4439 $this->clearInstanceCache();
4441 $this->saveOptions();
4442 return Status
::newGood();
4446 * Update the actor ID after an insert
4447 * @param IDatabase $dbw Writable database handle
4449 private function updateActorId( IDatabase
$dbw ) {
4450 global $wgActorTableSchemaMigrationStage;
4452 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4455 [ 'actor_user' => $this->mId
, 'actor_name' => $this->mName
],
4458 $this->mActorId
= (int)$dbw->insertId();
4463 * If this user is logged-in and blocked,
4464 * block any IP address they've successfully logged in from.
4465 * @return bool A block was spread
4467 public function spreadAnyEditBlock() {
4468 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4469 return $this->spreadBlock();
4476 * If this (non-anonymous) user is blocked,
4477 * block the IP address they've successfully logged in from.
4478 * @return bool A block was spread
4480 protected function spreadBlock() {
4481 wfDebug( __METHOD__
. "()\n" );
4483 if ( $this->mId
== 0 ) {
4487 $userblock = Block
::newFromTarget( $this->getName() );
4488 if ( !$userblock ) {
4492 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4496 * Get whether the user is explicitly blocked from account creation.
4497 * @return bool|Block
4499 public function isBlockedFromCreateAccount() {
4500 $this->getBlockedStatus();
4501 if ( $this->mBlock
&& $this->mBlock
->appliesToRight( 'createaccount' ) ) {
4502 return $this->mBlock
;
4505 # T15611: if the IP address the user is trying to create an account from is
4506 # blocked with createaccount disabled, prevent new account creation there even
4507 # when the user is logged in
4508 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4509 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4511 return $this->mBlockedFromCreateAccount
instanceof Block
4512 && $this->mBlockedFromCreateAccount
->appliesToRight( 'createaccount' )
4513 ?
$this->mBlockedFromCreateAccount
4518 * Get whether the user is blocked from using Special:Emailuser.
4521 public function isBlockedFromEmailuser() {
4522 $this->getBlockedStatus();
4523 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'sendemail' );
4527 * Get whether the user is blocked from using Special:Upload
4532 public function isBlockedFromUpload() {
4533 $this->getBlockedStatus();
4534 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'upload' );
4538 * Get whether the user is allowed to create an account.
4541 public function isAllowedToCreateAccount() {
4542 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4546 * Get this user's personal page title.
4548 * @return Title User's personal page title
4550 public function getUserPage() {
4551 return Title
::makeTitle( NS_USER
, $this->getName() );
4555 * Get this user's talk page title.
4557 * @return Title User's talk page title
4559 public function getTalkPage() {
4560 $title = $this->getUserPage();
4561 return $title->getTalkPage();
4565 * Determine whether the user is a newbie. Newbies are either
4566 * anonymous IPs, or the most recently created accounts.
4569 public function isNewbie() {
4570 return !$this->isAllowed( 'autoconfirmed' );
4574 * Check to see if the given clear-text password is one of the accepted passwords
4575 * @deprecated since 1.27, use AuthManager instead
4576 * @param string $password User password
4577 * @return bool True if the given password is correct, otherwise False
4579 public function checkPassword( $password ) {
4580 wfDeprecated( __METHOD__
, '1.27' );
4582 $manager = AuthManager
::singleton();
4583 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4584 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4586 'username' => $this->getName(),
4587 'password' => $password,
4590 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4591 switch ( $res->status
) {
4592 case AuthenticationResponse
::PASS
:
4594 case AuthenticationResponse
::FAIL
:
4595 // Hope it's not a PreAuthenticationProvider that failed...
4596 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4597 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4600 throw new BadMethodCallException(
4601 'AuthManager returned a response unsupported by ' . __METHOD__
4607 * Check if the given clear-text password matches the temporary password
4608 * sent by e-mail for password reset operations.
4610 * @deprecated since 1.27, use AuthManager instead
4611 * @param string $plaintext
4612 * @return bool True if matches, false otherwise
4614 public function checkTemporaryPassword( $plaintext ) {
4615 wfDeprecated( __METHOD__
, '1.27' );
4616 // Can't check the temporary password individually.
4617 return $this->checkPassword( $plaintext );
4621 * Initialize (if necessary) and return a session token value
4622 * which can be used in edit forms to show that the user's
4623 * login credentials aren't being hijacked with a foreign form
4627 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4628 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4629 * @return MediaWiki\Session\Token The new edit token
4631 public function getEditTokenObject( $salt = '', $request = null ) {
4632 if ( $this->isAnon() ) {
4633 return new LoggedOutEditToken();
4637 $request = $this->getRequest();
4639 return $request->getSession()->getToken( $salt );
4643 * Initialize (if necessary) and return a session token value
4644 * which can be used in edit forms to show that the user's
4645 * login credentials aren't being hijacked with a foreign form
4648 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4651 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4652 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4653 * @return string The new edit token
4655 public function getEditToken( $salt = '', $request = null ) {
4656 return $this->getEditTokenObject( $salt, $request )->toString();
4660 * Check given value against the token value stored in the session.
4661 * A match should confirm that the form was submitted from the
4662 * user's own login session, not a form submission from a third-party
4665 * @param string $val Input value to compare
4666 * @param string|array $salt Optional function-specific data for hashing
4667 * @param WebRequest|null $request Object to use or null to use $wgRequest
4668 * @param int|null $maxage Fail tokens older than this, in seconds
4669 * @return bool Whether the token matches
4671 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4672 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4676 * Check given value against the token value stored in the session,
4677 * ignoring the suffix.
4679 * @param string $val Input value to compare
4680 * @param string|array $salt Optional function-specific data for hashing
4681 * @param WebRequest|null $request Object to use or null to use $wgRequest
4682 * @param int|null $maxage Fail tokens older than this, in seconds
4683 * @return bool Whether the token matches
4685 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4686 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4687 return $this->matchEditToken( $val, $salt, $request, $maxage );
4691 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4692 * mail to the user's given address.
4694 * @param string $type Message to send, either "created", "changed" or "set"
4697 public function sendConfirmationMail( $type = 'created' ) {
4699 $expiration = null; // gets passed-by-ref and defined in next line.
4700 $token = $this->confirmationToken( $expiration );
4701 $url = $this->confirmationTokenUrl( $token );
4702 $invalidateURL = $this->invalidationTokenUrl( $token );
4703 $this->saveSettings();
4705 if ( $type == 'created' ||
$type === false ) {
4706 $message = 'confirmemail_body';
4708 } elseif ( $type === true ) {
4709 $message = 'confirmemail_body_changed';
4712 // Messages: confirmemail_body_changed, confirmemail_body_set
4713 $message = 'confirmemail_body_' . $type;
4717 'subject' => wfMessage( 'confirmemail_subject' )->text(),
4718 'body' => wfMessage( $message,
4719 $this->getRequest()->getIP(),
4722 $wgLang->userTimeAndDate( $expiration, $this ),
4724 $wgLang->userDate( $expiration, $this ),
4725 $wgLang->userTime( $expiration, $this ) )->text(),
4731 'ip' => $this->getRequest()->getIP(),
4732 'confirmURL' => $url,
4733 'invalidateURL' => $invalidateURL,
4734 'expiration' => $expiration
4737 Hooks
::run( 'UserSendConfirmationMail', [ $this, &$mail, $info ] );
4738 return $this->sendMail( $mail['subject'], $mail['body'], $mail['from'], $mail['replyTo'] );
4742 * Send an e-mail to this user's account. Does not check for
4743 * confirmed status or validity.
4745 * @param string $subject Message subject
4746 * @param string $body Message body
4747 * @param User|null $from Optional sending user; if unspecified, default
4748 * $wgPasswordSender will be used.
4749 * @param MailAddress|null $replyto Reply-To address
4752 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4753 global $wgPasswordSender;
4755 if ( $from instanceof User
) {
4756 $sender = MailAddress
::newFromUser( $from );
4758 $sender = new MailAddress( $wgPasswordSender,
4759 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4761 $to = MailAddress
::newFromUser( $this );
4763 return UserMailer
::send( $to, $sender, $subject, $body, [
4764 'replyTo' => $replyto,
4769 * Generate, store, and return a new e-mail confirmation code.
4770 * A hash (unsalted, since it's used as a key) is stored.
4772 * @note Call saveSettings() after calling this function to commit
4773 * this change to the database.
4775 * @param string &$expiration Accepts the expiration time
4776 * @return string New token
4778 protected function confirmationToken( &$expiration ) {
4779 global $wgUserEmailConfirmationTokenExpiry;
4781 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4782 $expiration = wfTimestamp( TS_MW
, $expires );
4784 $token = MWCryptRand
::generateHex( 32 );
4785 $hash = md5( $token );
4786 $this->mEmailToken
= $hash;
4787 $this->mEmailTokenExpires
= $expiration;
4792 * Return a URL the user can use to confirm their email address.
4793 * @param string $token Accepts the email confirmation token
4794 * @return string New token URL
4796 protected function confirmationTokenUrl( $token ) {
4797 return $this->getTokenUrl( 'ConfirmEmail', $token );
4801 * Return a URL the user can use to invalidate their email address.
4802 * @param string $token Accepts the email confirmation token
4803 * @return string New token URL
4805 protected function invalidationTokenUrl( $token ) {
4806 return $this->getTokenUrl( 'InvalidateEmail', $token );
4810 * Internal function to format the e-mail validation/invalidation URLs.
4811 * This uses a quickie hack to use the
4812 * hardcoded English names of the Special: pages, for ASCII safety.
4814 * @note Since these URLs get dropped directly into emails, using the
4815 * short English names avoids insanely long URL-encoded links, which
4816 * also sometimes can get corrupted in some browsers/mailers
4817 * (T8957 with Gmail and Internet Explorer).
4819 * @param string $page Special page
4820 * @param string $token
4821 * @return string Formatted URL
4823 protected function getTokenUrl( $page, $token ) {
4824 // Hack to bypass localization of 'Special:'
4825 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4826 return $title->getCanonicalURL();
4830 * Mark the e-mail address confirmed.
4832 * @note Call saveSettings() after calling this function to commit the change.
4836 public function confirmEmail() {
4837 // Check if it's already confirmed, so we don't touch the database
4838 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4839 if ( !$this->isEmailConfirmed() ) {
4840 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4841 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4847 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4848 * address if it was already confirmed.
4850 * @note Call saveSettings() after calling this function to commit the change.
4851 * @return bool Returns true
4853 public function invalidateEmail() {
4855 $this->mEmailToken
= null;
4856 $this->mEmailTokenExpires
= null;
4857 $this->setEmailAuthenticationTimestamp( null );
4859 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4864 * Set the e-mail authentication timestamp.
4865 * @param string $timestamp TS_MW timestamp
4867 public function setEmailAuthenticationTimestamp( $timestamp ) {
4869 $this->mEmailAuthenticated
= $timestamp;
4870 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4874 * Is this user allowed to send e-mails within limits of current
4875 * site configuration?
4878 public function canSendEmail() {
4879 global $wgEnableEmail, $wgEnableUserEmail;
4880 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4883 $canSend = $this->isEmailConfirmed();
4884 // Avoid PHP 7.1 warning of passing $this by reference
4886 Hooks
::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
4891 * Is this user allowed to receive e-mails within limits of current
4892 * site configuration?
4895 public function canReceiveEmail() {
4896 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4900 * Is this user's e-mail address valid-looking and confirmed within
4901 * limits of the current site configuration?
4903 * @note If $wgEmailAuthentication is on, this may require the user to have
4904 * confirmed their address by returning a code or using a password
4905 * sent to the address from the wiki.
4909 public function isEmailConfirmed() {
4910 global $wgEmailAuthentication;
4912 // Avoid PHP 7.1 warning of passing $this by reference
4915 if ( Hooks
::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
4916 if ( $this->isAnon() ) {
4919 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4922 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4932 * Check whether there is an outstanding request for e-mail confirmation.
4935 public function isEmailConfirmationPending() {
4936 global $wgEmailAuthentication;
4937 return $wgEmailAuthentication &&
4938 !$this->isEmailConfirmed() &&
4939 $this->mEmailToken
&&
4940 $this->mEmailTokenExpires
> wfTimestamp();
4944 * Get the timestamp of account creation.
4946 * @return string|bool|null Timestamp of account creation, false for
4947 * non-existent/anonymous user accounts, or null if existing account
4948 * but information is not in database.
4950 public function getRegistration() {
4951 if ( $this->isAnon() ) {
4955 return $this->mRegistration
;
4959 * Get the timestamp of the first edit
4961 * @return string|bool Timestamp of first edit, or false for
4962 * non-existent/anonymous user accounts.
4964 public function getFirstEditTimestamp() {
4965 return $this->getEditTimestamp( true );
4969 * Get the timestamp of the latest edit
4972 * @return string|bool Timestamp of first edit, or false for
4973 * non-existent/anonymous user accounts.
4975 public function getLatestEditTimestamp() {
4976 return $this->getEditTimestamp( false );
4980 * Get the timestamp of the first or latest edit
4982 * @param bool $first True for the first edit, false for the latest one
4983 * @return string|bool Timestamp of first or latest edit, or false for
4984 * non-existent/anonymous user accounts.
4986 private function getEditTimestamp( $first ) {
4987 if ( $this->getId() == 0 ) {
4988 return false; // anons
4990 $dbr = wfGetDB( DB_REPLICA
);
4991 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
4992 $tsField = isset( $actorWhere['tables']['temp_rev_user'] )
4993 ?
'revactor_timestamp' : 'rev_timestamp';
4994 $sortOrder = $first ?
'ASC' : 'DESC';
4995 $time = $dbr->selectField(
4996 [ 'revision' ] +
$actorWhere['tables'],
4998 [ $actorWhere['conds'] ],
5000 [ 'ORDER BY' => "$tsField $sortOrder" ],
5001 $actorWhere['joins']
5004 return false; // no edits
5006 return wfTimestamp( TS_MW
, $time );
5010 * Get the permissions associated with a given list of groups
5012 * @param array $groups Array of Strings List of internal group names
5013 * @return array Array of Strings List of permission key names for given groups combined
5015 public static function getGroupPermissions( $groups ) {
5016 global $wgGroupPermissions, $wgRevokePermissions;
5018 // grant every granted permission first
5019 foreach ( $groups as $group ) {
5020 if ( isset( $wgGroupPermissions[$group] ) ) {
5021 $rights = array_merge( $rights,
5022 // array_filter removes empty items
5023 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
5026 // now revoke the revoked permissions
5027 foreach ( $groups as $group ) {
5028 if ( isset( $wgRevokePermissions[$group] ) ) {
5029 $rights = array_diff( $rights,
5030 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
5033 return array_unique( $rights );
5037 * Get all the groups who have a given permission
5039 * @param string $role Role to check
5040 * @return array Array of Strings List of internal group names with the given permission
5042 public static function getGroupsWithPermission( $role ) {
5043 global $wgGroupPermissions;
5044 $allowedGroups = [];
5045 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
5046 if ( self
::groupHasPermission( $group, $role ) ) {
5047 $allowedGroups[] = $group;
5050 return $allowedGroups;
5054 * Check, if the given group has the given permission
5056 * If you're wanting to check whether all users have a permission, use
5057 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
5061 * @param string $group Group to check
5062 * @param string $role Role to check
5065 public static function groupHasPermission( $group, $role ) {
5066 global $wgGroupPermissions, $wgRevokePermissions;
5067 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
5068 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
5072 * Check if all users may be assumed to have the given permission
5074 * We generally assume so if the right is granted to '*' and isn't revoked
5075 * on any group. It doesn't attempt to take grants or other extension
5076 * limitations on rights into account in the general case, though, as that
5077 * would require it to always return false and defeat the purpose.
5078 * Specifically, session-based rights restrictions (such as OAuth or bot
5079 * passwords) are applied based on the current session.
5082 * @param string $right Right to check
5085 public static function isEveryoneAllowed( $right ) {
5086 global $wgGroupPermissions, $wgRevokePermissions;
5089 // Use the cached results, except in unit tests which rely on
5090 // being able change the permission mid-request
5091 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
5092 return $cache[$right];
5095 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
5096 $cache[$right] = false;
5100 // If it's revoked anywhere, then everyone doesn't have it
5101 foreach ( $wgRevokePermissions as $rights ) {
5102 if ( isset( $rights[$right] ) && $rights[$right] ) {
5103 $cache[$right] = false;
5108 // Remove any rights that aren't allowed to the global-session user,
5109 // unless there are no sessions for this endpoint.
5110 if ( !defined( 'MW_NO_SESSION' ) ) {
5111 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
5112 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
5113 $cache[$right] = false;
5118 // Allow extensions to say false
5119 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
5120 $cache[$right] = false;
5124 $cache[$right] = true;
5129 * Return the set of defined explicit groups.
5130 * The implicit groups (by default *, 'user' and 'autoconfirmed')
5131 * are not included, as they are defined automatically, not in the database.
5132 * @return array Array of internal group names
5134 public static function getAllGroups() {
5135 global $wgGroupPermissions, $wgRevokePermissions;
5136 return array_values( array_diff(
5137 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
5138 self
::getImplicitGroups()
5143 * Get a list of all available permissions.
5144 * @return string[] Array of permission names
5146 public static function getAllRights() {
5147 if ( self
::$mAllRights === false ) {
5148 global $wgAvailableRights;
5149 if ( count( $wgAvailableRights ) ) {
5150 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
5152 self
::$mAllRights = self
::$mCoreRights;
5154 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
5156 return self
::$mAllRights;
5160 * Get a list of implicit groups
5161 * TODO: Should we deprecate this? It's trivial, but we don't want to encourage use of globals.
5163 * @return array Array of Strings Array of internal group names
5165 public static function getImplicitGroups() {
5166 global $wgImplicitGroups;
5167 return $wgImplicitGroups;
5171 * Get the title of a page describing a particular group
5172 * @deprecated since 1.29 Use UserGroupMembership::getGroupPage instead
5174 * @param string $group Internal group name
5175 * @return Title|bool Title of the page if it exists, false otherwise
5177 public static function getGroupPage( $group ) {
5178 wfDeprecated( __METHOD__
, '1.29' );
5179 return UserGroupMembership
::getGroupPage( $group );
5183 * Create a link to the group in HTML, if available;
5184 * else return the group name.
5185 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5186 * make the link yourself if you need custom text
5188 * @param string $group Internal name of the group
5189 * @param string $text The text of the link
5190 * @return string HTML link to the group
5192 public static function makeGroupLinkHTML( $group, $text = '' ) {
5193 wfDeprecated( __METHOD__
, '1.29' );
5195 if ( $text == '' ) {
5196 $text = UserGroupMembership
::getGroupName( $group );
5198 $title = UserGroupMembership
::getGroupPage( $group );
5200 return MediaWikiServices
::getInstance()
5201 ->getLinkRenderer()->makeLink( $title, $text );
5204 return htmlspecialchars( $text );
5208 * Create a link to the group in Wikitext, if available;
5209 * else return the group name.
5210 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5211 * make the link yourself if you need custom text
5213 * @param string $group Internal name of the group
5214 * @param string $text The text of the link
5215 * @return string Wikilink to the group
5217 public static function makeGroupLinkWiki( $group, $text = '' ) {
5218 wfDeprecated( __METHOD__
, '1.29' );
5220 if ( $text == '' ) {
5221 $text = UserGroupMembership
::getGroupName( $group );
5223 $title = UserGroupMembership
::getGroupPage( $group );
5225 $page = $title->getFullText();
5226 return "[[$page|$text]]";
5233 * Returns an array of the groups that a particular group can add/remove.
5235 * @param string $group The group to check for whether it can add/remove
5236 * @return array Array( 'add' => array( addablegroups ),
5237 * 'remove' => array( removablegroups ),
5238 * 'add-self' => array( addablegroups to self),
5239 * 'remove-self' => array( removable groups from self) )
5241 public static function changeableByGroup( $group ) {
5242 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
5251 if ( empty( $wgAddGroups[$group] ) ) {
5252 // Don't add anything to $groups
5253 } elseif ( $wgAddGroups[$group] === true ) {
5254 // You get everything
5255 $groups['add'] = self
::getAllGroups();
5256 } elseif ( is_array( $wgAddGroups[$group] ) ) {
5257 $groups['add'] = $wgAddGroups[$group];
5260 // Same thing for remove
5261 if ( empty( $wgRemoveGroups[$group] ) ) {
5263 } elseif ( $wgRemoveGroups[$group] === true ) {
5264 $groups['remove'] = self
::getAllGroups();
5265 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
5266 $groups['remove'] = $wgRemoveGroups[$group];
5269 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
5270 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
5271 foreach ( $wgGroupsAddToSelf as $key => $value ) {
5272 if ( is_int( $key ) ) {
5273 $wgGroupsAddToSelf['user'][] = $value;
5278 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
5279 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
5280 if ( is_int( $key ) ) {
5281 $wgGroupsRemoveFromSelf['user'][] = $value;
5286 // Now figure out what groups the user can add to him/herself
5287 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
5289 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
5290 // No idea WHY this would be used, but it's there
5291 $groups['add-self'] = self
::getAllGroups();
5292 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
5293 $groups['add-self'] = $wgGroupsAddToSelf[$group];
5296 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
5298 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
5299 $groups['remove-self'] = self
::getAllGroups();
5300 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
5301 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
5308 * Returns an array of groups that this user can add and remove
5309 * @return array Array( 'add' => array( addablegroups ),
5310 * 'remove' => array( removablegroups ),
5311 * 'add-self' => array( addablegroups to self),
5312 * 'remove-self' => array( removable groups from self) )
5314 public function changeableGroups() {
5315 if ( $this->isAllowed( 'userrights' ) ) {
5316 // This group gives the right to modify everything (reverse-
5317 // compatibility with old "userrights lets you change
5319 // Using array_merge to make the groups reindexed
5320 $all = array_merge( self
::getAllGroups() );
5329 // Okay, it's not so simple, we will have to go through the arrays
5336 $addergroups = $this->getEffectiveGroups();
5338 foreach ( $addergroups as $addergroup ) {
5339 $groups = array_merge_recursive(
5340 $groups, $this->changeableByGroup( $addergroup )
5342 $groups['add'] = array_unique( $groups['add'] );
5343 $groups['remove'] = array_unique( $groups['remove'] );
5344 $groups['add-self'] = array_unique( $groups['add-self'] );
5345 $groups['remove-self'] = array_unique( $groups['remove-self'] );
5351 * Schedule a deferred update to update the user's edit count
5353 public function incEditCount() {
5354 if ( $this->isAnon() ) {
5358 DeferredUpdates
::addUpdate(
5359 new UserEditCountUpdate( $this, 1 ),
5360 DeferredUpdates
::POSTSEND
5365 * This method should not be called outside User/UserEditCountUpdate
5369 public function setEditCountInternal( $count ) {
5370 $this->mEditCount
= $count;
5374 * Initialize user_editcount from data out of the revision table
5376 * This method should not be called outside User/UserEditCountUpdate
5378 * @return int Number of edits
5380 public function initEditCountInternal() {
5381 // Pull from a replica DB to be less cruel to servers
5382 // Accuracy isn't the point anyway here
5383 $dbr = wfGetDB( DB_REPLICA
);
5384 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5385 $count = (int)$dbr->selectField(
5386 [ 'revision' ] +
$actorWhere['tables'],
5388 [ $actorWhere['conds'] ],
5391 $actorWhere['joins']
5394 $dbw = wfGetDB( DB_MASTER
);
5397 [ 'user_editcount' => $count ],
5399 'user_id' => $this->getId(),
5400 'user_editcount IS NULL OR user_editcount < ' . (int)$count
5409 * Get the description of a given right
5412 * @param string $right Right to query
5413 * @return string Localized description of the right
5415 public static function getRightDescription( $right ) {
5416 $key = "right-$right";
5417 $msg = wfMessage( $key );
5418 return $msg->isDisabled() ?
$right : $msg->text();
5422 * Get the name of a given grant
5425 * @param string $grant Grant to query
5426 * @return string Localized name of the grant
5428 public static function getGrantName( $grant ) {
5429 $key = "grant-$grant";
5430 $msg = wfMessage( $key );
5431 return $msg->isDisabled() ?
$grant : $msg->text();
5435 * Add a newuser log entry for this user.
5436 * Before 1.19 the return value was always true.
5438 * @deprecated since 1.27, AuthManager handles logging
5439 * @param string|bool $action Account creation type.
5440 * - String, one of the following values:
5441 * - 'create' for an anonymous user creating an account for himself.
5442 * This will force the action's performer to be the created user itself,
5443 * no matter the value of $wgUser
5444 * - 'create2' for a logged in user creating an account for someone else
5445 * - 'byemail' when the created user will receive its password by e-mail
5446 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5447 * - Boolean means whether the account was created by e-mail (deprecated):
5448 * - true will be converted to 'byemail'
5449 * - false will be converted to 'create' if this object is the same as
5450 * $wgUser and to 'create2' otherwise
5451 * @param string $reason User supplied reason
5454 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5455 return true; // disabled
5459 * Add an autocreate newuser log entry for this user
5460 * Used by things like CentralAuth and perhaps other authplugins.
5461 * Consider calling addNewUserLogEntry() directly instead.
5463 * @deprecated since 1.27, AuthManager handles logging
5466 public function addNewUserLogEntryAutoCreate() {
5467 $this->addNewUserLogEntry( 'autocreate' );
5473 * Load the user options either from cache, the database or an array
5475 * @param array|null $data Rows for the current user out of the user_properties table
5477 protected function loadOptions( $data = null ) {
5480 if ( $this->mOptionsLoaded
) {
5484 $this->mOptions
= self
::getDefaultOptions();
5486 if ( !$this->getId() ) {
5487 // For unlogged-in users, load language/variant options from request.
5488 // There's no need to do it for logged-in users: they can set preferences,
5489 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5490 // so don't override user's choice (especially when the user chooses site default).
5491 $variant = MediaWikiServices
::getInstance()->getContentLanguage()->getDefaultVariant();
5492 $this->mOptions
['variant'] = $variant;
5493 $this->mOptions
['language'] = $variant;
5494 $this->mOptionsLoaded
= true;
5498 // Maybe load from the object
5499 if ( !is_null( $this->mOptionOverrides
) ) {
5500 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5501 foreach ( $this->mOptionOverrides
as $key => $value ) {
5502 $this->mOptions
[$key] = $value;
5505 if ( !is_array( $data ) ) {
5506 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5507 // Load from database
5508 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5509 ?
wfGetDB( DB_MASTER
)
5510 : wfGetDB( DB_REPLICA
);
5512 $res = $dbr->select(
5514 [ 'up_property', 'up_value' ],
5515 [ 'up_user' => $this->getId() ],
5519 $this->mOptionOverrides
= [];
5521 foreach ( $res as $row ) {
5522 // Convert '0' to 0. PHP's boolean conversion considers them both
5523 // false, but e.g. JavaScript considers the former as true.
5524 // @todo: T54542 Somehow determine the desired type (string/int/bool)
5525 // and convert all values here.
5526 if ( $row->up_value
=== '0' ) {
5529 $data[$row->up_property
] = $row->up_value
;
5533 foreach ( $data as $property => $value ) {
5534 $this->mOptionOverrides
[$property] = $value;
5535 $this->mOptions
[$property] = $value;
5539 // Replace deprecated language codes
5540 $this->mOptions
['language'] = LanguageCode
::replaceDeprecatedCodes(
5541 $this->mOptions
['language']
5544 $this->mOptionsLoaded
= true;
5546 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5550 * Saves the non-default options for this user, as previously set e.g. via
5551 * setOption(), in the database's "user_properties" (preferences) table.
5552 * Usually used via saveSettings().
5554 protected function saveOptions() {
5555 $this->loadOptions();
5557 // Not using getOptions(), to keep hidden preferences in database
5558 $saveOptions = $this->mOptions
;
5560 // Allow hooks to abort, for instance to save to a global profile.
5561 // Reset options to default state before saving.
5562 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5566 $userId = $this->getId();
5568 $insert_rows = []; // all the new preference rows
5569 foreach ( $saveOptions as $key => $value ) {
5570 // Don't bother storing default values
5571 $defaultOption = self
::getDefaultOption( $key );
5572 if ( ( $defaultOption === null && $value !== false && $value !== null )
5573 ||
$value != $defaultOption
5576 'up_user' => $userId,
5577 'up_property' => $key,
5578 'up_value' => $value,
5583 $dbw = wfGetDB( DB_MASTER
);
5585 $res = $dbw->select( 'user_properties',
5586 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5588 // Find prior rows that need to be removed or updated. These rows will
5589 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5591 foreach ( $res as $row ) {
5592 if ( !isset( $saveOptions[$row->up_property
] )
5593 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5595 $keysDelete[] = $row->up_property
;
5599 if ( count( $keysDelete ) ) {
5600 // Do the DELETE by PRIMARY KEY for prior rows.
5601 // In the past a very large portion of calls to this function are for setting
5602 // 'rememberpassword' for new accounts (a preference that has since been removed).
5603 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5604 // caused gap locks on [max user ID,+infinity) which caused high contention since
5605 // updates would pile up on each other as they are for higher (newer) user IDs.
5606 // It might not be necessary these days, but it shouldn't hurt either.
5607 $dbw->delete( 'user_properties',
5608 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5610 // Insert the new preference rows
5611 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5615 * Return the list of user fields that should be selected to create
5616 * a new user object.
5617 * @deprecated since 1.31, use self::getQueryInfo() instead.
5620 public static function selectFields() {
5621 wfDeprecated( __METHOD__
, '1.31' );
5629 'user_email_authenticated',
5631 'user_email_token_expires',
5632 'user_registration',
5638 * Return the tables, fields, and join conditions to be selected to create
5639 * a new user object.
5641 * @return array With three keys:
5642 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
5643 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
5644 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
5646 public static function getQueryInfo() {
5647 global $wgActorTableSchemaMigrationStage;
5650 'tables' => [ 'user' ],
5658 'user_email_authenticated',
5660 'user_email_token_expires',
5661 'user_registration',
5667 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
5668 // but it does little harm and might be needed for write callers loading a User.
5669 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
5670 $ret['tables']['user_actor'] = 'actor';
5671 $ret['fields'][] = 'user_actor.actor_id';
5672 $ret['joins']['user_actor'] = [
5673 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) ?
'JOIN' : 'LEFT JOIN',
5674 [ 'user_actor.actor_user = user_id' ]
5682 * Factory function for fatal permission-denied errors
5685 * @param string $permission User right required
5688 static function newFatalPermissionDeniedStatus( $permission ) {
5692 foreach ( self
::getGroupsWithPermission( $permission ) as $group ) {
5693 $groups[] = UserGroupMembership
::getLink( $group, RequestContext
::getMain(), 'wiki' );
5697 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5700 return Status
::newFatal( 'badaccess-group0' );
5704 * Get a new instance of this user that was loaded from the master via a locking read
5706 * Use this instead of the main context User when updating that user. This avoids races
5707 * where that user was loaded from a replica DB or even the master but without proper locks.
5709 * @return User|null Returns null if the user was not found in the DB
5712 public function getInstanceForUpdate() {
5713 if ( !$this->getId() ) {
5714 return null; // anon
5717 $user = self
::newFromId( $this->getId() );
5718 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5726 * Checks if two user objects point to the same user.
5728 * @since 1.25 ; takes a UserIdentity instead of a User since 1.32
5729 * @param UserIdentity $user
5732 public function equals( UserIdentity
$user ) {
5733 // XXX it's not clear whether central ID providers are supposed to obey this
5734 return $this->getName() === $user->getName();
5738 * Checks if usertalk is allowed
5742 public function isAllowUsertalk() {
5743 return $this->mAllowUsertalk
;