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 if ( $block->shouldTrackWithCookie( $this->isAnon() ) ) {
1410 $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( Database
$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 list( $max, $period ) = $userLimit;
2209 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
2210 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
2213 // ip-based limits for all ping-limitable users
2214 if ( isset( $limits['ip-all'] ) ) {
2215 $ip = $this->getRequest()->getIP();
2216 // ignore if user limit is more permissive
2217 if ( $isNewbie ||
$userLimit === false
2218 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
2219 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
2223 // subnet-based limits for all ping-limitable users
2224 if ( isset( $limits['subnet-all'] ) ) {
2225 $ip = $this->getRequest()->getIP();
2226 $subnet = IP
::getSubnet( $ip );
2227 if ( $subnet !== false ) {
2228 // ignore if user limit is more permissive
2229 if ( $isNewbie ||
$userLimit === false
2230 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
2231 > $userLimit[0] / $userLimit[1] ) {
2232 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
2238 foreach ( $keys as $key => $limit ) {
2239 list( $max, $period ) = $limit;
2240 $summary = "(limit $max in {$period}s)";
2241 $count = $cache->get( $key );
2244 if ( $count >= $max ) {
2245 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
2246 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
2249 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
2252 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
2253 if ( $incrBy > 0 ) {
2254 $cache->add( $key, 0, intval( $period ) ); // first ping
2257 if ( $incrBy > 0 ) {
2258 $cache->incr( $key, $incrBy );
2266 * Check if user is blocked
2268 * @param bool $fromReplica Whether to check the replica DB instead of
2269 * the master. Hacked from false due to horrible probs on site.
2270 * @return bool True if blocked, false otherwise
2272 public function isBlocked( $fromReplica = true ) {
2273 return $this->getBlock( $fromReplica ) instanceof Block
&&
2274 $this->getBlock()->appliesToRight( 'edit' );
2278 * Get the block affecting the user, or null if the user is not blocked
2280 * @param bool $fromReplica Whether to check the replica DB instead of the master
2281 * @return Block|null
2283 public function getBlock( $fromReplica = true ) {
2284 $this->getBlockedStatus( $fromReplica );
2285 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
2289 * Check if user is blocked from editing a particular article
2291 * @param Title $title Title to check
2292 * @param bool $fromReplica Whether to check the replica DB instead of the master
2295 public function isBlockedFrom( $title, $fromReplica = false ) {
2296 $blocked = $this->isHidden();
2299 $block = $this->getBlock( $fromReplica );
2301 // Special handling for a user's own talk page. The block is not aware
2302 // of the user, so this must be done here.
2303 if ( $title->equals( $this->getTalkPage() ) ) {
2304 $blocked = $block->appliesToUsertalk( $title );
2306 $blocked = $block->appliesToTitle( $title );
2311 // only for the purpose of the hook. We really don't need this here.
2312 $allowUsertalk = $this->mAllowUsertalk
;
2314 Hooks
::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
2320 * If user is blocked, return the name of the user who placed the block
2321 * @return string Name of blocker
2323 public function blockedBy() {
2324 $this->getBlockedStatus();
2325 return $this->mBlockedby
;
2329 * If user is blocked, return the specified reason for the block
2330 * @return string Blocking reason
2332 public function blockedFor() {
2333 $this->getBlockedStatus();
2334 return $this->mBlockreason
;
2338 * If user is blocked, return the ID for the block
2339 * @return int Block ID
2341 public function getBlockId() {
2342 $this->getBlockedStatus();
2343 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2347 * Check if user is blocked on all wikis.
2348 * Do not use for actual edit permission checks!
2349 * This is intended for quick UI checks.
2351 * @param string $ip IP address, uses current client if none given
2352 * @return bool True if blocked, false otherwise
2354 public function isBlockedGlobally( $ip = '' ) {
2355 return $this->getGlobalBlock( $ip ) instanceof Block
;
2359 * Check if user is blocked on all wikis.
2360 * Do not use for actual edit permission checks!
2361 * This is intended for quick UI checks.
2363 * @param string $ip IP address, uses current client if none given
2364 * @return Block|null Block object if blocked, null otherwise
2365 * @throws FatalError
2366 * @throws MWException
2368 public function getGlobalBlock( $ip = '' ) {
2369 if ( $this->mGlobalBlock
!== null ) {
2370 return $this->mGlobalBlock ?
: null;
2372 // User is already an IP?
2373 if ( IP
::isIPAddress( $this->getName() ) ) {
2374 $ip = $this->getName();
2376 $ip = $this->getRequest()->getIP();
2378 // Avoid PHP 7.1 warning of passing $this by reference
2382 Hooks
::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
2384 if ( $blocked && $block === null ) {
2385 // back-compat: UserIsBlockedGlobally didn't have $block param first
2386 $block = new Block( [
2388 'systemBlock' => 'global-block'
2392 $this->mGlobalBlock
= $blocked ?
$block : false;
2393 return $this->mGlobalBlock ?
: null;
2397 * Check if user account is locked
2399 * @return bool True if locked, false otherwise
2401 public function isLocked() {
2402 if ( $this->mLocked
!== null ) {
2403 return $this->mLocked
;
2406 $this->mLocked
= false;
2407 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2408 return $this->mLocked
;
2412 * Check if user account is hidden
2414 * @return bool True if hidden, false otherwise
2416 public function isHidden() {
2417 if ( $this->mHideName
!== null ) {
2418 return (bool)$this->mHideName
;
2420 $this->getBlockedStatus();
2421 if ( !$this->mHideName
) {
2423 $this->mHideName
= false;
2424 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2426 return (bool)$this->mHideName
;
2430 * Get the user's ID.
2431 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2433 public function getId() {
2434 if ( $this->mId
=== null && $this->mName
!== null && self
::isIP( $this->mName
) ) {
2435 // Special case, we know the user is anonymous
2439 if ( !$this->isItemLoaded( 'id' ) ) {
2440 // Don't load if this was initialized from an ID
2444 return (int)$this->mId
;
2448 * Set the user and reload all fields according to a given ID
2449 * @param int $v User ID to reload
2451 public function setId( $v ) {
2453 $this->clearInstanceCache( 'id' );
2457 * Get the user name, or the IP of an anonymous user
2458 * @return string User's name or IP address
2460 public function getName() {
2461 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2462 // Special case optimisation
2463 return $this->mName
;
2467 if ( $this->mName
=== false ) {
2469 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2472 return $this->mName
;
2476 * Set the user name.
2478 * This does not reload fields from the database according to the given
2479 * name. Rather, it is used to create a temporary "nonexistent user" for
2480 * later addition to the database. It can also be used to set the IP
2481 * address for an anonymous user to something other than the current
2484 * @note User::newFromName() has roughly the same function, when the named user
2486 * @param string $str New user name to set
2488 public function setName( $str ) {
2490 $this->mName
= $str;
2494 * Get the user's actor ID.
2496 * @param IDatabase|null $dbw Assign a new actor ID, using this DB handle, if none exists
2497 * @return int The actor's ID, or 0 if no actor ID exists and $dbw was null
2499 public function getActorId( IDatabase
$dbw = null ) {
2500 global $wgActorTableSchemaMigrationStage;
2502 // Technically we should always return 0 without SCHEMA_COMPAT_READ_NEW,
2503 // but it does little harm and might be needed for write callers loading a User.
2504 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) ) {
2508 if ( !$this->isItemLoaded( 'actor' ) ) {
2512 // Currently $this->mActorId might be null if $this was loaded from a
2513 // cache entry that was written when $wgActorTableSchemaMigrationStage
2514 // was SCHEMA_COMPAT_OLD. Once that is no longer a possibility (i.e. when
2515 // User::VERSION is incremented after $wgActorTableSchemaMigrationStage
2516 // has been removed), that condition may be removed.
2517 if ( $this->mActorId
=== null ||
!$this->mActorId
&& $dbw ) {
2519 'actor_user' => $this->getId() ?
: null,
2520 'actor_name' => (string)$this->getName(),
2523 if ( $q['actor_user'] === null && self
::isUsableName( $q['actor_name'] ) ) {
2524 throw new CannotCreateActorException(
2525 'Cannot create an actor for a usable name that is not an existing user'
2528 if ( $q['actor_name'] === '' ) {
2529 throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
2531 $dbw->insert( 'actor', $q, __METHOD__
, [ 'IGNORE' ] );
2532 if ( $dbw->affectedRows() ) {
2533 $this->mActorId
= (int)$dbw->insertId();
2536 // Use LOCK IN SHARE MODE to bypass any MySQL REPEATABLE-READ snapshot.
2537 $this->mActorId
= (int)$dbw->selectField(
2542 [ 'LOCK IN SHARE MODE' ]
2544 if ( !$this->mActorId
) {
2545 throw new CannotCreateActorException(
2546 "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
2550 $this->invalidateCache();
2552 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2553 $db = wfGetDB( $index );
2554 $this->mActorId
= (int)$db->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2556 $this->setItemLoaded( 'actor' );
2559 return (int)$this->mActorId
;
2563 * Get the user's name escaped by underscores.
2564 * @return string Username escaped by underscores.
2566 public function getTitleKey() {
2567 return str_replace( ' ', '_', $this->getName() );
2571 * Check if the user has new messages.
2572 * @return bool True if the user has new messages
2574 public function getNewtalk() {
2577 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2578 if ( $this->mNewtalk
=== -1 ) {
2579 $this->mNewtalk
= false; # reset talk page status
2581 // Check memcached separately for anons, who have no
2582 // entire User object stored in there.
2583 if ( !$this->mId
) {
2584 global $wgDisableAnonTalk;
2585 if ( $wgDisableAnonTalk ) {
2586 // Anon newtalk disabled by configuration.
2587 $this->mNewtalk
= false;
2589 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2592 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2596 return (bool)$this->mNewtalk
;
2600 * Return the data needed to construct links for new talk page message
2601 * alerts. If there are new messages, this will return an associative array
2602 * with the following data:
2603 * wiki: The database name of the wiki
2604 * link: Root-relative link to the user's talk page
2605 * rev: The last talk page revision that the user has seen or null. This
2606 * is useful for building diff links.
2607 * If there are no new messages, it returns an empty array.
2608 * @note This function was designed to accomodate multiple talk pages, but
2609 * currently only returns a single link and revision.
2612 public function getNewMessageLinks() {
2613 // Avoid PHP 7.1 warning of passing $this by reference
2616 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
2620 if ( !$this->getNewtalk() ) {
2623 $utp = $this->getTalkPage();
2624 $dbr = wfGetDB( DB_REPLICA
);
2625 // Get the "last viewed rev" timestamp from the oldest message notification
2626 $timestamp = $dbr->selectField( 'user_newtalk',
2627 'MIN(user_last_timestamp)',
2628 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2630 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2633 'wiki' => WikiMap
::getWikiIdFromDbDomain( WikiMap
::getCurrentWikiDbDomain() ),
2634 'link' => $utp->getLocalURL(),
2641 * Get the revision ID for the last talk page revision viewed by the talk
2643 * @return int|null Revision ID or null
2645 public function getNewMessageRevisionId() {
2646 $newMessageRevisionId = null;
2647 $newMessageLinks = $this->getNewMessageLinks();
2649 // Note: getNewMessageLinks() never returns more than a single link
2650 // and it is always for the same wiki, but we double-check here in
2651 // case that changes some time in the future.
2652 if ( $newMessageLinks && count( $newMessageLinks ) === 1
2653 && WikiMap
::isCurrentWikiId( $newMessageLinks[0]['wiki'] )
2654 && $newMessageLinks[0]['rev']
2656 /** @var Revision $newMessageRevision */
2657 $newMessageRevision = $newMessageLinks[0]['rev'];
2658 $newMessageRevisionId = $newMessageRevision->getId();
2661 return $newMessageRevisionId;
2665 * Internal uncached check for new messages
2668 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2669 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2670 * @return bool True if the user has new messages
2672 protected function checkNewtalk( $field, $id ) {
2673 $dbr = wfGetDB( DB_REPLICA
);
2675 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2677 return $ok !== false;
2681 * Add or update the new messages flag
2682 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2683 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2684 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2685 * @return bool True if successful, false otherwise
2687 protected function updateNewtalk( $field, $id, $curRev = null ) {
2688 // Get timestamp of the talk page revision prior to the current one
2689 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2690 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2691 // Mark the user as having new messages since this revision
2692 $dbw = wfGetDB( DB_MASTER
);
2693 $dbw->insert( 'user_newtalk',
2694 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2697 if ( $dbw->affectedRows() ) {
2698 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2702 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2707 * Clear the new messages flag for the given user
2708 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2709 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2710 * @return bool True if successful, false otherwise
2712 protected function deleteNewtalk( $field, $id ) {
2713 $dbw = wfGetDB( DB_MASTER
);
2714 $dbw->delete( 'user_newtalk',
2717 if ( $dbw->affectedRows() ) {
2718 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2722 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2727 * Update the 'You have new messages!' status.
2728 * @param bool $val Whether the user has new messages
2729 * @param Revision|null $curRev New, as yet unseen revision of the user talk
2730 * page. Ignored if null or !$val.
2732 public function setNewtalk( $val, $curRev = null ) {
2733 if ( wfReadOnly() ) {
2738 $this->mNewtalk
= $val;
2740 if ( $this->isAnon() ) {
2742 $id = $this->getName();
2745 $id = $this->getId();
2749 $changed = $this->updateNewtalk( $field, $id, $curRev );
2751 $changed = $this->deleteNewtalk( $field, $id );
2755 $this->invalidateCache();
2760 * Generate a current or new-future timestamp to be stored in the
2761 * user_touched field when we update things.
2763 * @return string Timestamp in TS_MW format
2765 private function newTouchedTimestamp() {
2767 if ( $this->mTouched
) {
2768 $time = max( $time, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2771 return wfTimestamp( TS_MW
, $time );
2775 * Clear user data from memcached
2777 * Use after applying updates to the database; caller's
2778 * responsibility to update user_touched if appropriate.
2780 * Called implicitly from invalidateCache() and saveSettings().
2782 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2784 public function clearSharedCache( $mode = 'changed' ) {
2785 if ( !$this->getId() ) {
2789 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2790 $key = $this->getCacheKey( $cache );
2791 if ( $mode === 'refresh' ) {
2792 $cache->delete( $key, 1 );
2794 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2795 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2796 $lb->getConnection( DB_MASTER
)->onTransactionPreCommitOrIdle(
2797 function () use ( $cache, $key ) {
2798 $cache->delete( $key );
2803 $cache->delete( $key );
2809 * Immediately touch the user data cache for this account
2811 * Calls touch() and removes account data from memcached
2813 public function invalidateCache() {
2815 $this->clearSharedCache();
2819 * Update the "touched" timestamp for the user
2821 * This is useful on various login/logout events when making sure that
2822 * a browser or proxy that has multiple tenants does not suffer cache
2823 * pollution where the new user sees the old users content. The value
2824 * of getTouched() is checked when determining 304 vs 200 responses.
2825 * Unlike invalidateCache(), this preserves the User object cache and
2826 * avoids database writes.
2830 public function touch() {
2831 $id = $this->getId();
2833 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2834 $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
2835 $cache->touchCheckKey( $key );
2836 $this->mQuickTouched
= null;
2841 * Validate the cache for this account.
2842 * @param string $timestamp A timestamp in TS_MW format
2845 public function validateCache( $timestamp ) {
2846 return ( $timestamp >= $this->getTouched() );
2850 * Get the user touched timestamp
2852 * Use this value only to validate caches via inequalities
2853 * such as in the case of HTTP If-Modified-Since response logic
2855 * @return string TS_MW Timestamp
2857 public function getTouched() {
2861 if ( $this->mQuickTouched
=== null ) {
2862 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2863 $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId
);
2865 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2868 return max( $this->mTouched
, $this->mQuickTouched
);
2871 return $this->mTouched
;
2875 * Get the user_touched timestamp field (time of last DB updates)
2876 * @return string TS_MW Timestamp
2879 public function getDBTouched() {
2882 return $this->mTouched
;
2886 * Set the password and reset the random token.
2887 * Calls through to authentication plugin if necessary;
2888 * will have no effect if the auth plugin refuses to
2889 * pass the change through or if the legal password
2892 * As a special case, setting the password to null
2893 * wipes it, so the account cannot be logged in until
2894 * a new password is set, for instance via e-mail.
2896 * @deprecated since 1.27, use AuthManager instead
2897 * @param string $str New password to set
2898 * @throws PasswordError On failure
2901 public function setPassword( $str ) {
2902 wfDeprecated( __METHOD__
, '1.27' );
2903 return $this->setPasswordInternal( $str );
2907 * Set the password and reset the random token unconditionally.
2909 * @deprecated since 1.27, use AuthManager instead
2910 * @param string|null $str New password to set or null to set an invalid
2911 * password hash meaning that the user will not be able to log in
2912 * through the web interface.
2914 public function setInternalPassword( $str ) {
2915 wfDeprecated( __METHOD__
, '1.27' );
2916 $this->setPasswordInternal( $str );
2920 * Actually set the password and such
2921 * @since 1.27 cannot set a password for a user not in the database
2922 * @param string|null $str New password to set or null to set an invalid
2923 * password hash meaning that the user will not be able to log in
2924 * through the web interface.
2925 * @return bool Success
2927 private function setPasswordInternal( $str ) {
2928 $manager = AuthManager
::singleton();
2930 // If the user doesn't exist yet, fail
2931 if ( !$manager->userExists( $this->getName() ) ) {
2932 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2935 $status = $this->changeAuthenticationData( [
2936 'username' => $this->getName(),
2940 if ( !$status->isGood() ) {
2941 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2942 ->info( __METHOD__
. ': Password change rejected: '
2943 . $status->getWikiText( null, null, 'en' ) );
2947 $this->setOption( 'watchlisttoken', false );
2948 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2954 * Changes credentials of the user.
2956 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2957 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2958 * e.g. when no provider handled the change.
2960 * @param array $data A set of authentication data in fieldname => value format. This is the
2961 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2965 public function changeAuthenticationData( array $data ) {
2966 $manager = AuthManager
::singleton();
2967 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2968 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2970 $status = Status
::newGood( 'ignored' );
2971 foreach ( $reqs as $req ) {
2972 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2974 if ( $status->getValue() === 'ignored' ) {
2975 $status->warning( 'authenticationdatachange-ignored' );
2978 if ( $status->isGood() ) {
2979 foreach ( $reqs as $req ) {
2980 $manager->changeAuthenticationData( $req );
2987 * Get the user's current token.
2988 * @param bool $forceCreation Force the generation of a new token if the
2989 * user doesn't have one (default=true for backwards compatibility).
2990 * @return string|null Token
2992 public function getToken( $forceCreation = true ) {
2993 global $wgAuthenticationTokenVersion;
2996 if ( !$this->mToken
&& $forceCreation ) {
3000 if ( !$this->mToken
) {
3001 // The user doesn't have a token, return null to indicate that.
3005 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
3006 // We return a random value here so existing token checks are very
3008 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3011 if ( $wgAuthenticationTokenVersion === null ) {
3012 // $wgAuthenticationTokenVersion not in use, so return the raw secret
3013 return $this->mToken
;
3016 // $wgAuthenticationTokenVersion in use, so hmac it.
3017 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
3019 // The raw hash can be overly long. Shorten it up.
3020 $len = max( 32, self
::TOKEN_LENGTH
);
3021 if ( strlen( $ret ) < $len ) {
3022 // Should never happen, even md5 is 128 bits
3023 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
3026 return substr( $ret, -$len );
3030 * Set the random token (used for persistent authentication)
3031 * Called from loadDefaults() among other places.
3033 * @param string|bool $token If specified, set the token to this value
3035 public function setToken( $token = false ) {
3037 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
3038 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3039 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
3040 } elseif ( !$token ) {
3041 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3043 $this->mToken
= $token;
3048 * Set the password for a password reminder or new account email
3050 * @deprecated Removed in 1.27. Use PasswordReset instead.
3051 * @param string $str New password to set or null to set an invalid
3052 * password hash meaning that the user will not be able to use it
3053 * @param bool $throttle If true, reset the throttle timestamp to the present
3055 public function setNewpassword( $str, $throttle = true ) {
3056 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
3060 * Get the user's e-mail address
3061 * @return string User's email address
3063 public function getEmail() {
3065 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
3066 return $this->mEmail
;
3070 * Get the timestamp of the user's e-mail authentication
3071 * @return string TS_MW timestamp
3073 public function getEmailAuthenticationTimestamp() {
3075 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
3076 return $this->mEmailAuthenticated
;
3080 * Set the user's e-mail address
3081 * @param string $str New e-mail address
3083 public function setEmail( $str ) {
3085 if ( $str == $this->mEmail
) {
3088 $this->invalidateEmail();
3089 $this->mEmail
= $str;
3090 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
3094 * Set the user's e-mail address and a confirmation mail if needed.
3097 * @param string $str New e-mail address
3100 public function setEmailWithConfirmation( $str ) {
3101 global $wgEnableEmail, $wgEmailAuthentication;
3103 if ( !$wgEnableEmail ) {
3104 return Status
::newFatal( 'emaildisabled' );
3107 $oldaddr = $this->getEmail();
3108 if ( $str === $oldaddr ) {
3109 return Status
::newGood( true );
3112 $type = $oldaddr != '' ?
'changed' : 'set';
3113 $notificationResult = null;
3115 if ( $wgEmailAuthentication && $type === 'changed' ) {
3116 // Send the user an email notifying the user of the change in registered
3117 // email address on their previous email address
3118 $change = $str != '' ?
'changed' : 'removed';
3119 $notificationResult = $this->sendMail(
3120 wfMessage( 'notificationemail_subject_' . $change )->text(),
3121 wfMessage( 'notificationemail_body_' . $change,
3122 $this->getRequest()->getIP(),
3128 $this->setEmail( $str );
3130 if ( $str !== '' && $wgEmailAuthentication ) {
3131 // Send a confirmation request to the new address if needed
3132 $result = $this->sendConfirmationMail( $type );
3134 if ( $notificationResult !== null ) {
3135 $result->merge( $notificationResult );
3138 if ( $result->isGood() ) {
3139 // Say to the caller that a confirmation and notification mail has been sent
3140 $result->value
= 'eauth';
3143 $result = Status
::newGood( true );
3150 * Get the user's real name
3151 * @return string User's real name
3153 public function getRealName() {
3154 if ( !$this->isItemLoaded( 'realname' ) ) {
3158 return $this->mRealName
;
3162 * Set the user's real name
3163 * @param string $str New real name
3165 public function setRealName( $str ) {
3167 $this->mRealName
= $str;
3171 * Get the user's current setting for a given option.
3173 * @param string $oname The option to check
3174 * @param string|array|null $defaultOverride A default value returned if the option does not exist
3175 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
3176 * @return string|array|int|null User's current value for the option
3177 * @see getBoolOption()
3178 * @see getIntOption()
3180 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
3181 global $wgHiddenPrefs;
3182 $this->loadOptions();
3184 # We want 'disabled' preferences to always behave as the default value for
3185 # users, even if they have set the option explicitly in their settings (ie they
3186 # set it, and then it was disabled removing their ability to change it). But
3187 # we don't want to erase the preferences in the database in case the preference
3188 # is re-enabled again. So don't touch $mOptions, just override the returned value
3189 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
3190 return self
::getDefaultOption( $oname );
3193 if ( array_key_exists( $oname, $this->mOptions
) ) {
3194 return $this->mOptions
[$oname];
3197 return $defaultOverride;
3201 * Get all user's options
3203 * @param int $flags Bitwise combination of:
3204 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
3205 * to the default value. (Since 1.25)
3208 public function getOptions( $flags = 0 ) {
3209 global $wgHiddenPrefs;
3210 $this->loadOptions();
3211 $options = $this->mOptions
;
3213 # We want 'disabled' preferences to always behave as the default value for
3214 # users, even if they have set the option explicitly in their settings (ie they
3215 # set it, and then it was disabled removing their ability to change it). But
3216 # we don't want to erase the preferences in the database in case the preference
3217 # is re-enabled again. So don't touch $mOptions, just override the returned value
3218 foreach ( $wgHiddenPrefs as $pref ) {
3219 $default = self
::getDefaultOption( $pref );
3220 if ( $default !== null ) {
3221 $options[$pref] = $default;
3225 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
3226 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
3233 * Get the user's current setting for a given option, as a boolean value.
3235 * @param string $oname The option to check
3236 * @return bool User's current value for the option
3239 public function getBoolOption( $oname ) {
3240 return (bool)$this->getOption( $oname );
3244 * Get the user's current setting for a given option, as an integer value.
3246 * @param string $oname The option to check
3247 * @param int $defaultOverride A default value returned if the option does not exist
3248 * @return int User's current value for the option
3251 public function getIntOption( $oname, $defaultOverride = 0 ) {
3252 $val = $this->getOption( $oname );
3254 $val = $defaultOverride;
3256 return intval( $val );
3260 * Set the given option for a user.
3262 * You need to call saveSettings() to actually write to the database.
3264 * @param string $oname The option to set
3265 * @param mixed $val New value to set
3267 public function setOption( $oname, $val ) {
3268 $this->loadOptions();
3270 // Explicitly NULL values should refer to defaults
3271 if ( is_null( $val ) ) {
3272 $val = self
::getDefaultOption( $oname );
3275 $this->mOptions
[$oname] = $val;
3279 * Get a token stored in the preferences (like the watchlist one),
3280 * resetting it if it's empty (and saving changes).
3282 * @param string $oname The option name to retrieve the token from
3283 * @return string|bool User's current value for the option, or false if this option is disabled.
3284 * @see resetTokenFromOption()
3286 * @deprecated since 1.26 Applications should use the OAuth extension
3288 public function getTokenFromOption( $oname ) {
3289 global $wgHiddenPrefs;
3291 $id = $this->getId();
3292 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
3296 $token = $this->getOption( $oname );
3298 // Default to a value based on the user token to avoid space
3299 // wasted on storing tokens for all users. When this option
3300 // is set manually by the user, only then is it stored.
3301 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
3308 * Reset a token stored in the preferences (like the watchlist one).
3309 * *Does not* save user's preferences (similarly to setOption()).
3311 * @param string $oname The option name to reset the token in
3312 * @return string|bool New token value, or false if this option is disabled.
3313 * @see getTokenFromOption()
3316 public function resetTokenFromOption( $oname ) {
3317 global $wgHiddenPrefs;
3318 if ( in_array( $oname, $wgHiddenPrefs ) ) {
3322 $token = MWCryptRand
::generateHex( 40 );
3323 $this->setOption( $oname, $token );
3328 * Return a list of the types of user options currently returned by
3329 * User::getOptionKinds().
3331 * Currently, the option kinds are:
3332 * - 'registered' - preferences which are registered in core MediaWiki or
3333 * by extensions using the UserGetDefaultOptions hook.
3334 * - 'registered-multiselect' - as above, using the 'multiselect' type.
3335 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
3336 * - 'userjs' - preferences with names starting with 'userjs-', intended to
3337 * be used by user scripts.
3338 * - 'special' - "preferences" that are not accessible via User::getOptions
3339 * or User::setOptions.
3340 * - 'unused' - preferences about which MediaWiki doesn't know anything.
3341 * These are usually legacy options, removed in newer versions.
3343 * The API (and possibly others) use this function to determine the possible
3344 * option types for validation purposes, so make sure to update this when a
3345 * new option kind is added.
3347 * @see User::getOptionKinds
3348 * @return array Option kinds
3350 public static function listOptionKinds() {
3353 'registered-multiselect',
3354 'registered-checkmatrix',
3362 * Return an associative array mapping preferences keys to the kind of a preference they're
3363 * used for. Different kinds are handled differently when setting or reading preferences.
3365 * See User::listOptionKinds for the list of valid option types that can be provided.
3367 * @see User::listOptionKinds
3368 * @param IContextSource $context
3369 * @param array|null $options Assoc. array with options keys to check as keys.
3370 * Defaults to $this->mOptions.
3371 * @return array The key => kind mapping data
3373 public function getOptionKinds( IContextSource
$context, $options = null ) {
3374 $this->loadOptions();
3375 if ( $options === null ) {
3376 $options = $this->mOptions
;
3379 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
3380 $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
3383 // Pull out the "special" options, so they don't get converted as
3384 // multiselect or checkmatrix.
3385 $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
3386 foreach ( $specialOptions as $name => $value ) {
3387 unset( $prefs[$name] );
3390 // Multiselect and checkmatrix options are stored in the database with
3391 // one key per option, each having a boolean value. Extract those keys.
3392 $multiselectOptions = [];
3393 foreach ( $prefs as $name => $info ) {
3394 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3395 ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField
::class ) ) {
3396 $opts = HTMLFormField
::flattenOptions( $info['options'] );
3397 $prefix = $info['prefix'] ??
$name;
3399 foreach ( $opts as $value ) {
3400 $multiselectOptions["$prefix$value"] = true;
3403 unset( $prefs[$name] );
3406 $checkmatrixOptions = [];
3407 foreach ( $prefs as $name => $info ) {
3408 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3409 ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix
::class ) ) {
3410 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3411 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3412 $prefix = $info['prefix'] ??
$name;
3414 foreach ( $columns as $column ) {
3415 foreach ( $rows as $row ) {
3416 $checkmatrixOptions["$prefix$column-$row"] = true;
3420 unset( $prefs[$name] );
3424 // $value is ignored
3425 foreach ( $options as $key => $value ) {
3426 if ( isset( $prefs[$key] ) ) {
3427 $mapping[$key] = 'registered';
3428 } elseif ( isset( $multiselectOptions[$key] ) ) {
3429 $mapping[$key] = 'registered-multiselect';
3430 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3431 $mapping[$key] = 'registered-checkmatrix';
3432 } elseif ( isset( $specialOptions[$key] ) ) {
3433 $mapping[$key] = 'special';
3434 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3435 $mapping[$key] = 'userjs';
3437 $mapping[$key] = 'unused';
3445 * Reset certain (or all) options to the site defaults
3447 * The optional parameter determines which kinds of preferences will be reset.
3448 * Supported values are everything that can be reported by getOptionKinds()
3449 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3451 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3452 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3453 * for backwards-compatibility.
3454 * @param IContextSource|null $context Context source used when $resetKinds
3455 * does not contain 'all', passed to getOptionKinds().
3456 * Defaults to RequestContext::getMain() when null.
3458 public function resetOptions(
3459 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3460 IContextSource
$context = null
3463 $defaultOptions = self
::getDefaultOptions();
3465 if ( !is_array( $resetKinds ) ) {
3466 $resetKinds = [ $resetKinds ];
3469 if ( in_array( 'all', $resetKinds ) ) {
3470 $newOptions = $defaultOptions;
3472 if ( $context === null ) {
3473 $context = RequestContext
::getMain();
3476 $optionKinds = $this->getOptionKinds( $context );
3477 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3480 // Use default values for the options that should be deleted, and
3481 // copy old values for the ones that shouldn't.
3482 foreach ( $this->mOptions
as $key => $value ) {
3483 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3484 if ( array_key_exists( $key, $defaultOptions ) ) {
3485 $newOptions[$key] = $defaultOptions[$key];
3488 $newOptions[$key] = $value;
3493 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3495 $this->mOptions
= $newOptions;
3496 $this->mOptionsLoaded
= true;
3500 * Get the user's preferred date format.
3501 * @return string User's preferred date format
3503 public function getDatePreference() {
3504 // Important migration for old data rows
3505 if ( is_null( $this->mDatePreference
) ) {
3507 $value = $this->getOption( 'date' );
3508 $map = $wgLang->getDatePreferenceMigrationMap();
3509 if ( isset( $map[$value] ) ) {
3510 $value = $map[$value];
3512 $this->mDatePreference
= $value;
3514 return $this->mDatePreference
;
3518 * Determine based on the wiki configuration and the user's options,
3519 * whether this user must be over HTTPS no matter what.
3523 public function requiresHTTPS() {
3524 global $wgSecureLogin;
3525 if ( !$wgSecureLogin ) {
3529 $https = $this->getBoolOption( 'prefershttps' );
3530 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3532 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3539 * Get the user preferred stub threshold
3543 public function getStubThreshold() {
3544 global $wgMaxArticleSize; # Maximum article size, in Kb
3545 $threshold = $this->getIntOption( 'stubthreshold' );
3546 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3547 // If they have set an impossible value, disable the preference
3548 // so we can use the parser cache again.
3555 * Get the permissions this user has.
3556 * @return string[] permission names
3558 public function getRights() {
3559 if ( is_null( $this->mRights
) ) {
3560 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3561 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3563 // Deny any rights denied by the user's session, unless this
3564 // endpoint has no sessions.
3565 if ( !defined( 'MW_NO_SESSION' ) ) {
3566 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3567 if ( $allowedRights !== null ) {
3568 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3572 Hooks
::run( 'UserGetRightsRemove', [ $this, &$this->mRights
] );
3573 // Force reindexation of rights when a hook has unset one of them
3574 $this->mRights
= array_values( array_unique( $this->mRights
) );
3576 // If block disables login, we should also remove any
3577 // extra rights blocked users might have, in case the
3578 // blocked user has a pre-existing session (T129738).
3579 // This is checked here for cases where people only call
3580 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3581 // to give a better error message in the common case.
3582 $config = RequestContext
::getMain()->getConfig();
3584 $this->isLoggedIn() &&
3585 $config->get( 'BlockDisablesLogin' ) &&
3589 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3592 return $this->mRights
;
3596 * Get the list of explicit group memberships this user has.
3597 * The implicit * and user groups are not included.
3599 * @return string[] Array of internal group names (sorted since 1.33)
3601 public function getGroups() {
3603 $this->loadGroups();
3604 return array_keys( $this->mGroupMemberships
);
3608 * Get the list of explicit group memberships this user has, stored as
3609 * UserGroupMembership objects. Implicit groups are not included.
3611 * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
3614 public function getGroupMemberships() {
3616 $this->loadGroups();
3617 return $this->mGroupMemberships
;
3621 * Get the list of implicit group memberships this user has.
3622 * This includes all explicit groups, plus 'user' if logged in,
3623 * '*' for all accounts, and autopromoted groups
3624 * @param bool $recache Whether to avoid the cache
3625 * @return array Array of String internal group names
3627 public function getEffectiveGroups( $recache = false ) {
3628 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3629 $this->mEffectiveGroups
= array_unique( array_merge(
3630 $this->getGroups(), // explicit groups
3631 $this->getAutomaticGroups( $recache ) // implicit groups
3633 // Avoid PHP 7.1 warning of passing $this by reference
3635 // Hook for additional groups
3636 Hooks
::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups
] );
3637 // Force reindexation of groups when a hook has unset one of them
3638 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3640 return $this->mEffectiveGroups
;
3644 * Get the list of implicit group memberships this user has.
3645 * This includes 'user' if logged in, '*' for all accounts,
3646 * and autopromoted groups
3647 * @param bool $recache Whether to avoid the cache
3648 * @return array Array of String internal group names
3650 public function getAutomaticGroups( $recache = false ) {
3651 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3652 $this->mImplicitGroups
= [ '*' ];
3653 if ( $this->getId() ) {
3654 $this->mImplicitGroups
[] = 'user';
3656 $this->mImplicitGroups
= array_unique( array_merge(
3657 $this->mImplicitGroups
,
3658 Autopromote
::getAutopromoteGroups( $this )
3662 // Assure data consistency with rights/groups,
3663 // as getEffectiveGroups() depends on this function
3664 $this->mEffectiveGroups
= null;
3667 return $this->mImplicitGroups
;
3671 * Returns the groups the user has belonged to.
3673 * The user may still belong to the returned groups. Compare with getGroups().
3675 * The function will not return groups the user had belonged to before MW 1.17
3677 * @return array Names of the groups the user has belonged to.
3679 public function getFormerGroups() {
3682 if ( is_null( $this->mFormerGroups
) ) {
3683 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3684 ?
wfGetDB( DB_MASTER
)
3685 : wfGetDB( DB_REPLICA
);
3686 $res = $db->select( 'user_former_groups',
3688 [ 'ufg_user' => $this->mId
],
3690 $this->mFormerGroups
= [];
3691 foreach ( $res as $row ) {
3692 $this->mFormerGroups
[] = $row->ufg_group
;
3696 return $this->mFormerGroups
;
3700 * Get the user's edit count.
3701 * @return int|null Null for anonymous users
3703 public function getEditCount() {
3704 if ( !$this->getId() ) {
3708 if ( $this->mEditCount
=== null ) {
3709 /* Populate the count, if it has not been populated yet */
3710 $dbr = wfGetDB( DB_REPLICA
);
3711 // check if the user_editcount field has been initialized
3712 $count = $dbr->selectField(
3713 'user', 'user_editcount',
3714 [ 'user_id' => $this->mId
],
3718 if ( $count === null ) {
3719 // it has not been initialized. do so.
3720 $count = $this->initEditCountInternal();
3722 $this->mEditCount
= $count;
3724 return (int)$this->mEditCount
;
3728 * Add the user to the given group. This takes immediate effect.
3729 * If the user is already in the group, the expiry time will be updated to the new
3730 * expiry time. (If $expiry is omitted or null, the membership will be altered to
3733 * @param string $group Name of the group to add
3734 * @param string|null $expiry Optional expiry timestamp in any format acceptable to
3735 * wfTimestamp(), or null if the group assignment should not expire
3738 public function addGroup( $group, $expiry = null ) {
3740 $this->loadGroups();
3743 $expiry = wfTimestamp( TS_MW
, $expiry );
3746 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
3750 // create the new UserGroupMembership and put it in the DB
3751 $ugm = new UserGroupMembership( $this->mId
, $group, $expiry );
3752 if ( !$ugm->insert( true ) ) {
3756 $this->mGroupMemberships
[$group] = $ugm;
3758 // Refresh the groups caches, and clear the rights cache so it will be
3759 // refreshed on the next call to $this->getRights().
3760 $this->getEffectiveGroups( true );
3761 $this->mRights
= null;
3763 $this->invalidateCache();
3769 * Remove the user from the given group.
3770 * This takes immediate effect.
3771 * @param string $group Name of the group to remove
3774 public function removeGroup( $group ) {
3777 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3781 $ugm = UserGroupMembership
::getMembership( $this->mId
, $group );
3782 // delete the membership entry
3783 if ( !$ugm ||
!$ugm->delete() ) {
3787 $this->loadGroups();
3788 unset( $this->mGroupMemberships
[$group] );
3790 // Refresh the groups caches, and clear the rights cache so it will be
3791 // refreshed on the next call to $this->getRights().
3792 $this->getEffectiveGroups( true );
3793 $this->mRights
= null;
3795 $this->invalidateCache();
3801 * Get whether the user is logged in
3804 public function isLoggedIn() {
3805 return $this->getId() != 0;
3809 * Get whether the user is anonymous
3812 public function isAnon() {
3813 return !$this->isLoggedIn();
3817 * @return bool Whether this user is flagged as being a bot role account
3820 public function isBot() {
3821 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3826 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3832 * Check if user is allowed to access a feature / make an action
3834 * @param string $permissions,... Permissions to test
3835 * @return bool True if user is allowed to perform *any* of the given actions
3837 public function isAllowedAny() {
3838 $permissions = func_get_args();
3839 foreach ( $permissions as $permission ) {
3840 if ( $this->isAllowed( $permission ) ) {
3849 * @param string $permissions,... Permissions to test
3850 * @return bool True if the user is allowed to perform *all* of the given actions
3852 public function isAllowedAll() {
3853 $permissions = func_get_args();
3854 foreach ( $permissions as $permission ) {
3855 if ( !$this->isAllowed( $permission ) ) {
3863 * Internal mechanics of testing a permission
3864 * @param string $action
3867 public function isAllowed( $action = '' ) {
3868 if ( $action === '' ) {
3869 return true; // In the spirit of DWIM
3871 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3872 // by misconfiguration: 0 == 'foo'
3873 return in_array( $action, $this->getRights(), true );
3877 * Check whether to enable recent changes patrol features for this user
3878 * @return bool True or false
3880 public function useRCPatrol() {
3881 global $wgUseRCPatrol;
3882 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3886 * Check whether to enable new pages patrol features for this user
3887 * @return bool True or false
3889 public function useNPPatrol() {
3890 global $wgUseRCPatrol, $wgUseNPPatrol;
3892 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3893 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3898 * Check whether to enable new files patrol features for this user
3899 * @return bool True or false
3901 public function useFilePatrol() {
3902 global $wgUseRCPatrol, $wgUseFilePatrol;
3904 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3905 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3910 * Get the WebRequest object to use with this object
3912 * @return WebRequest
3914 public function getRequest() {
3915 if ( $this->mRequest
) {
3916 return $this->mRequest
;
3924 * Check the watched status of an article.
3925 * @since 1.22 $checkRights parameter added
3926 * @param Title $title Title of the article to look at
3927 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3928 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3931 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3932 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3933 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3940 * @since 1.22 $checkRights parameter added
3941 * @param Title $title Title of the article to look at
3942 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3943 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3945 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3946 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3947 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3949 [ $title->getSubjectPage(), $title->getTalkPage() ]
3952 $this->invalidateCache();
3956 * Stop watching an article.
3957 * @since 1.22 $checkRights parameter added
3958 * @param Title $title Title of the article to look at
3959 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3960 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3962 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3963 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3964 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3965 $store->removeWatch( $this, $title->getSubjectPage() );
3966 $store->removeWatch( $this, $title->getTalkPage() );
3968 $this->invalidateCache();
3972 * Clear the user's notification timestamp for the given title.
3973 * If e-notif e-mails are on, they will receive notification mails on
3974 * the next change of the page if it's watched etc.
3975 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3976 * @param Title &$title Title of the article to look at
3977 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3979 public function clearNotification( &$title, $oldid = 0 ) {
3980 global $wgUseEnotif, $wgShowUpdatedMarker;
3982 // Do nothing if the database is locked to writes
3983 if ( wfReadOnly() ) {
3987 // Do nothing if not allowed to edit the watchlist
3988 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3992 // If we're working on user's talk page, we should update the talk page message indicator
3993 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3994 // Avoid PHP 7.1 warning of passing $this by reference
3996 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
4000 // Try to update the DB post-send and only if needed...
4001 DeferredUpdates
::addCallableUpdate( function () use ( $title, $oldid ) {
4002 if ( !$this->getNewtalk() ) {
4003 return; // no notifications to clear
4006 // Delete the last notifications (they stack up)
4007 $this->setNewtalk( false );
4009 // If there is a new, unseen, revision, use its timestamp
4011 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
4014 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
4019 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4023 if ( $this->isAnon() ) {
4024 // Nothing else to do...
4028 // Only update the timestamp if the page is being watched.
4029 // The query to find out if it is watched is cached both in memcached and per-invocation,
4030 // and when it does have to be executed, it can be on a replica DB
4031 // If this is the user's newtalk page, we always update the timestamp
4033 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
4037 MediaWikiServices
::getInstance()->getWatchedItemStore()
4038 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
4042 * Resets all of the given user's page-change notification timestamps.
4043 * If e-notif e-mails are on, they will receive notification mails on
4044 * the next change of any watched page.
4045 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
4047 public function clearAllNotifications() {
4048 global $wgUseEnotif, $wgShowUpdatedMarker;
4049 // Do nothing if not allowed to edit the watchlist
4050 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
4054 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4055 $this->setNewtalk( false );
4059 $id = $this->getId();
4064 $watchedItemStore = MediaWikiServices
::getInstance()->getWatchedItemStore();
4065 $watchedItemStore->resetAllNotificationTimestampsForUser( $this );
4067 // We also need to clear here the "you have new message" notification for the own
4068 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
4072 * Compute experienced level based on edit count and registration date.
4074 * @return string 'newcomer', 'learner', or 'experienced'
4076 public function getExperienceLevel() {
4077 global $wgLearnerEdits,
4078 $wgExperiencedUserEdits,
4079 $wgLearnerMemberSince,
4080 $wgExperiencedUserMemberSince;
4082 if ( $this->isAnon() ) {
4086 $editCount = $this->getEditCount();
4087 $registration = $this->getRegistration();
4089 $learnerRegistration = wfTimestamp( TS_MW
, $now - $wgLearnerMemberSince * 86400 );
4090 $experiencedRegistration = wfTimestamp( TS_MW
, $now - $wgExperiencedUserMemberSince * 86400 );
4092 if ( $editCount < $wgLearnerEdits ||
4093 $registration > $learnerRegistration ) {
4097 if ( $editCount > $wgExperiencedUserEdits &&
4098 $registration <= $experiencedRegistration
4100 return 'experienced';
4107 * Persist this user's session (e.g. set cookies)
4109 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
4111 * @param bool|null $secure Whether to force secure/insecure cookies or use default
4112 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
4114 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
4116 if ( $this->mId
== 0 ) {
4120 $session = $this->getRequest()->getSession();
4121 if ( $request && $session->getRequest() !== $request ) {
4122 $session = $session->sessionWithRequest( $request );
4124 $delay = $session->delaySave();
4126 if ( !$session->getUser()->equals( $this ) ) {
4127 if ( !$session->canSetUser() ) {
4128 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4129 ->warning( __METHOD__
.
4130 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
4134 $session->setUser( $this );
4137 $session->setRememberUser( $rememberMe );
4138 if ( $secure !== null ) {
4139 $session->setForceHTTPS( $secure );
4142 $session->persist();
4144 ScopedCallback
::consume( $delay );
4148 * Log this user out.
4150 public function logout() {
4151 // Avoid PHP 7.1 warning of passing $this by reference
4153 if ( Hooks
::run( 'UserLogout', [ &$user ] ) ) {
4159 * Clear the user's session, and reset the instance cache.
4162 public function doLogout() {
4163 $session = $this->getRequest()->getSession();
4164 if ( !$session->canSetUser() ) {
4165 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4166 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
4167 $error = 'immutable';
4168 } elseif ( !$session->getUser()->equals( $this ) ) {
4169 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4170 ->warning( __METHOD__
.
4171 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
4173 // But we still may as well make this user object anon
4174 $this->clearInstanceCache( 'defaults' );
4175 $error = 'wronguser';
4177 $this->clearInstanceCache( 'defaults' );
4178 $delay = $session->delaySave();
4179 $session->unpersist(); // Clear cookies (T127436)
4180 $session->setLoggedOutTimestamp( time() );
4181 $session->setUser( new User
);
4182 $session->set( 'wsUserID', 0 ); // Other code expects this
4183 $session->resetAllTokens();
4184 ScopedCallback
::consume( $delay );
4187 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
4188 'event' => 'logout',
4189 'successful' => $error === false,
4190 'status' => $error ?
: 'success',
4195 * Save this user's settings into the database.
4196 * @todo Only rarely do all these fields need to be set!
4198 public function saveSettings() {
4199 if ( wfReadOnly() ) {
4200 // @TODO: caller should deal with this instead!
4201 // This should really just be an exception.
4202 MWExceptionHandler
::logException( new DBExpectedError(
4204 "Could not update user with ID '{$this->mId}'; DB is read-only."
4210 if ( $this->mId
== 0 ) {
4214 // Get a new user_touched that is higher than the old one.
4215 // This will be used for a CAS check as a last-resort safety
4216 // check against race conditions and replica DB lag.
4217 $newTouched = $this->newTouchedTimestamp();
4219 $dbw = wfGetDB( DB_MASTER
);
4220 $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $newTouched ) {
4221 global $wgActorTableSchemaMigrationStage;
4223 $dbw->update( 'user',
4225 'user_name' => $this->mName
,
4226 'user_real_name' => $this->mRealName
,
4227 'user_email' => $this->mEmail
,
4228 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4229 'user_touched' => $dbw->timestamp( $newTouched ),
4230 'user_token' => strval( $this->mToken
),
4231 'user_email_token' => $this->mEmailToken
,
4232 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
4233 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
4234 'user_id' => $this->mId
,
4238 if ( !$dbw->affectedRows() ) {
4239 // Maybe the problem was a missed cache update; clear it to be safe
4240 $this->clearSharedCache( 'refresh' );
4241 // User was changed in the meantime or loaded with stale data
4242 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
4243 LoggerFactory
::getInstance( 'preferences' )->warning(
4244 "CAS update failed on user_touched for user ID '{user_id}' ({db_flag} read)",
4245 [ 'user_id' => $this->mId
, 'db_flag' => $from ]
4247 throw new MWException( "CAS update failed on user_touched. " .
4248 "The version of the user to be saved is older than the current version."
4252 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4255 [ 'actor_name' => $this->mName
],
4256 [ 'actor_user' => $this->mId
],
4262 $this->mTouched
= $newTouched;
4263 $this->saveOptions();
4265 Hooks
::run( 'UserSaveSettings', [ $this ] );
4266 $this->clearSharedCache();
4267 $this->getUserPage()->purgeSquid();
4271 * If only this user's username is known, and it exists, return the user ID.
4273 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
4276 public function idForName( $flags = 0 ) {
4277 $s = trim( $this->getName() );
4282 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
4283 ?
wfGetDB( DB_MASTER
)
4284 : wfGetDB( DB_REPLICA
);
4286 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
4287 ?
[ 'LOCK IN SHARE MODE' ]
4290 $id = $db->selectField( 'user',
4291 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
4297 * Add a user to the database, return the user object
4299 * @param string $name Username to add
4300 * @param array $params Array of Strings Non-default parameters to save to
4301 * the database as user_* fields:
4302 * - email: The user's email address.
4303 * - email_authenticated: The email authentication timestamp.
4304 * - real_name: The user's real name.
4305 * - options: An associative array of non-default options.
4306 * - token: Random authentication token. Do not set.
4307 * - registration: Registration timestamp. Do not set.
4309 * @return User|null User object, or null if the username already exists.
4311 public static function createNew( $name, $params = [] ) {
4312 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
4313 if ( isset( $params[$field] ) ) {
4314 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
4315 unset( $params[$field] );
4321 $user->setToken(); // init token
4322 if ( isset( $params['options'] ) ) {
4323 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
4324 unset( $params['options'] );
4326 $dbw = wfGetDB( DB_MASTER
);
4328 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4331 'user_name' => $name,
4332 'user_password' => $noPass,
4333 'user_newpassword' => $noPass,
4334 'user_email' => $user->mEmail
,
4335 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
4336 'user_real_name' => $user->mRealName
,
4337 'user_token' => strval( $user->mToken
),
4338 'user_registration' => $dbw->timestamp( $user->mRegistration
),
4339 'user_editcount' => 0,
4340 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4342 foreach ( $params as $name => $value ) {
4343 $fields["user_$name"] = $value;
4346 return $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $fields ) {
4347 $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
4348 if ( $dbw->affectedRows() ) {
4349 $newUser = self
::newFromId( $dbw->insertId() );
4350 $newUser->mName
= $fields['user_name'];
4351 $newUser->updateActorId( $dbw );
4352 // Load the user from master to avoid replica lag
4353 $newUser->load( self
::READ_LATEST
);
4362 * Add this existing user object to the database. If the user already
4363 * exists, a fatal status object is returned, and the user object is
4364 * initialised with the data from the database.
4366 * Previously, this function generated a DB error due to a key conflict
4367 * if the user already existed. Many extension callers use this function
4368 * in code along the lines of:
4370 * $user = User::newFromName( $name );
4371 * if ( !$user->isLoggedIn() ) {
4372 * $user->addToDatabase();
4374 * // do something with $user...
4376 * However, this was vulnerable to a race condition (T18020). By
4377 * initialising the user object if the user exists, we aim to support this
4378 * calling sequence as far as possible.
4380 * Note that if the user exists, this function will acquire a write lock,
4381 * so it is still advisable to make the call conditional on isLoggedIn(),
4382 * and to commit the transaction after calling.
4384 * @throws MWException
4387 public function addToDatabase() {
4389 if ( !$this->mToken
) {
4390 $this->setToken(); // init token
4393 if ( !is_string( $this->mName
) ) {
4394 throw new RuntimeException( "User name field is not set." );
4397 $this->mTouched
= $this->newTouchedTimestamp();
4399 $dbw = wfGetDB( DB_MASTER
);
4400 $status = $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) {
4401 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4402 $dbw->insert( 'user',
4404 'user_name' => $this->mName
,
4405 'user_password' => $noPass,
4406 'user_newpassword' => $noPass,
4407 'user_email' => $this->mEmail
,
4408 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4409 'user_real_name' => $this->mRealName
,
4410 'user_token' => strval( $this->mToken
),
4411 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4412 'user_editcount' => 0,
4413 'user_touched' => $dbw->timestamp( $this->mTouched
),
4417 if ( !$dbw->affectedRows() ) {
4418 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4419 $this->mId
= $dbw->selectField(
4422 [ 'user_name' => $this->mName
],
4424 [ 'LOCK IN SHARE MODE' ]
4428 if ( $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4433 throw new MWException( $fname . ": hit a key conflict attempting " .
4434 "to insert user '{$this->mName}' row, but it was not present in select!" );
4436 return Status
::newFatal( 'userexists' );
4438 $this->mId
= $dbw->insertId();
4439 self
::$idCacheByName[$this->mName
] = $this->mId
;
4440 $this->updateActorId( $dbw );
4442 return Status
::newGood();
4444 if ( !$status->isGood() ) {
4448 // Clear instance cache other than user table data and actor, which is already accurate
4449 $this->clearInstanceCache();
4451 $this->saveOptions();
4452 return Status
::newGood();
4456 * Update the actor ID after an insert
4457 * @param IDatabase $dbw Writable database handle
4459 private function updateActorId( IDatabase
$dbw ) {
4460 global $wgActorTableSchemaMigrationStage;
4462 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4465 [ 'actor_user' => $this->mId
, 'actor_name' => $this->mName
],
4468 $this->mActorId
= (int)$dbw->insertId();
4473 * If this user is logged-in and blocked,
4474 * block any IP address they've successfully logged in from.
4475 * @return bool A block was spread
4477 public function spreadAnyEditBlock() {
4478 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4479 return $this->spreadBlock();
4486 * If this (non-anonymous) user is blocked,
4487 * block the IP address they've successfully logged in from.
4488 * @return bool A block was spread
4490 protected function spreadBlock() {
4491 wfDebug( __METHOD__
. "()\n" );
4493 if ( $this->mId
== 0 ) {
4497 $userblock = Block
::newFromTarget( $this->getName() );
4498 if ( !$userblock ) {
4502 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4506 * Get whether the user is explicitly blocked from account creation.
4507 * @return bool|Block
4509 public function isBlockedFromCreateAccount() {
4510 $this->getBlockedStatus();
4511 if ( $this->mBlock
&& $this->mBlock
->appliesToRight( 'createaccount' ) ) {
4512 return $this->mBlock
;
4515 # T15611: if the IP address the user is trying to create an account from is
4516 # blocked with createaccount disabled, prevent new account creation there even
4517 # when the user is logged in
4518 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4519 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4521 return $this->mBlockedFromCreateAccount
instanceof Block
4522 && $this->mBlockedFromCreateAccount
->appliesToRight( 'createaccount' )
4523 ?
$this->mBlockedFromCreateAccount
4528 * Get whether the user is blocked from using Special:Emailuser.
4531 public function isBlockedFromEmailuser() {
4532 $this->getBlockedStatus();
4533 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'sendemail' );
4537 * Get whether the user is blocked from using Special:Upload
4542 public function isBlockedFromUpload() {
4543 $this->getBlockedStatus();
4544 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'upload' );
4548 * Get whether the user is allowed to create an account.
4551 public function isAllowedToCreateAccount() {
4552 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4556 * Get this user's personal page title.
4558 * @return Title User's personal page title
4560 public function getUserPage() {
4561 return Title
::makeTitle( NS_USER
, $this->getName() );
4565 * Get this user's talk page title.
4567 * @return Title User's talk page title
4569 public function getTalkPage() {
4570 $title = $this->getUserPage();
4571 return $title->getTalkPage();
4575 * Determine whether the user is a newbie. Newbies are either
4576 * anonymous IPs, or the most recently created accounts.
4579 public function isNewbie() {
4580 return !$this->isAllowed( 'autoconfirmed' );
4584 * Check to see if the given clear-text password is one of the accepted passwords
4585 * @deprecated since 1.27, use AuthManager instead
4586 * @param string $password User password
4587 * @return bool True if the given password is correct, otherwise False
4589 public function checkPassword( $password ) {
4590 wfDeprecated( __METHOD__
, '1.27' );
4592 $manager = AuthManager
::singleton();
4593 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4594 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4596 'username' => $this->getName(),
4597 'password' => $password,
4600 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4601 switch ( $res->status
) {
4602 case AuthenticationResponse
::PASS
:
4604 case AuthenticationResponse
::FAIL
:
4605 // Hope it's not a PreAuthenticationProvider that failed...
4606 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4607 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4610 throw new BadMethodCallException(
4611 'AuthManager returned a response unsupported by ' . __METHOD__
4617 * Check if the given clear-text password matches the temporary password
4618 * sent by e-mail for password reset operations.
4620 * @deprecated since 1.27, use AuthManager instead
4621 * @param string $plaintext
4622 * @return bool True if matches, false otherwise
4624 public function checkTemporaryPassword( $plaintext ) {
4625 wfDeprecated( __METHOD__
, '1.27' );
4626 // Can't check the temporary password individually.
4627 return $this->checkPassword( $plaintext );
4631 * Initialize (if necessary) and return a session token value
4632 * which can be used in edit forms to show that the user's
4633 * login credentials aren't being hijacked with a foreign form
4637 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4638 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4639 * @return MediaWiki\Session\Token The new edit token
4641 public function getEditTokenObject( $salt = '', $request = null ) {
4642 if ( $this->isAnon() ) {
4643 return new LoggedOutEditToken();
4647 $request = $this->getRequest();
4649 return $request->getSession()->getToken( $salt );
4653 * Initialize (if necessary) and return a session token value
4654 * which can be used in edit forms to show that the user's
4655 * login credentials aren't being hijacked with a foreign form
4658 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4661 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4662 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4663 * @return string The new edit token
4665 public function getEditToken( $salt = '', $request = null ) {
4666 return $this->getEditTokenObject( $salt, $request )->toString();
4670 * Check given value against the token value stored in the session.
4671 * A match should confirm that the form was submitted from the
4672 * user's own login session, not a form submission from a third-party
4675 * @param string $val Input value to compare
4676 * @param string|array $salt Optional function-specific data for hashing
4677 * @param WebRequest|null $request Object to use or null to use $wgRequest
4678 * @param int|null $maxage Fail tokens older than this, in seconds
4679 * @return bool Whether the token matches
4681 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4682 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4686 * Check given value against the token value stored in the session,
4687 * ignoring the suffix.
4689 * @param string $val Input value to compare
4690 * @param string|array $salt Optional function-specific data for hashing
4691 * @param WebRequest|null $request Object to use or null to use $wgRequest
4692 * @param int|null $maxage Fail tokens older than this, in seconds
4693 * @return bool Whether the token matches
4695 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4696 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4697 return $this->matchEditToken( $val, $salt, $request, $maxage );
4701 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4702 * mail to the user's given address.
4704 * @param string $type Message to send, either "created", "changed" or "set"
4707 public function sendConfirmationMail( $type = 'created' ) {
4709 $expiration = null; // gets passed-by-ref and defined in next line.
4710 $token = $this->confirmationToken( $expiration );
4711 $url = $this->confirmationTokenUrl( $token );
4712 $invalidateURL = $this->invalidationTokenUrl( $token );
4713 $this->saveSettings();
4715 if ( $type == 'created' ||
$type === false ) {
4716 $message = 'confirmemail_body';
4718 } elseif ( $type === true ) {
4719 $message = 'confirmemail_body_changed';
4722 // Messages: confirmemail_body_changed, confirmemail_body_set
4723 $message = 'confirmemail_body_' . $type;
4727 'subject' => wfMessage( 'confirmemail_subject' )->text(),
4728 'body' => wfMessage( $message,
4729 $this->getRequest()->getIP(),
4732 $wgLang->userTimeAndDate( $expiration, $this ),
4734 $wgLang->userDate( $expiration, $this ),
4735 $wgLang->userTime( $expiration, $this ) )->text(),
4741 'ip' => $this->getRequest()->getIP(),
4742 'confirmURL' => $url,
4743 'invalidateURL' => $invalidateURL,
4744 'expiration' => $expiration
4747 Hooks
::run( 'UserSendConfirmationMail', [ $this, &$mail, $info ] );
4748 return $this->sendMail( $mail['subject'], $mail['body'], $mail['from'], $mail['replyTo'] );
4752 * Send an e-mail to this user's account. Does not check for
4753 * confirmed status or validity.
4755 * @param string $subject Message subject
4756 * @param string $body Message body
4757 * @param User|null $from Optional sending user; if unspecified, default
4758 * $wgPasswordSender will be used.
4759 * @param MailAddress|null $replyto Reply-To address
4762 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4763 global $wgPasswordSender;
4765 if ( $from instanceof User
) {
4766 $sender = MailAddress
::newFromUser( $from );
4768 $sender = new MailAddress( $wgPasswordSender,
4769 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4771 $to = MailAddress
::newFromUser( $this );
4773 return UserMailer
::send( $to, $sender, $subject, $body, [
4774 'replyTo' => $replyto,
4779 * Generate, store, and return a new e-mail confirmation code.
4780 * A hash (unsalted, since it's used as a key) is stored.
4782 * @note Call saveSettings() after calling this function to commit
4783 * this change to the database.
4785 * @param string &$expiration Accepts the expiration time
4786 * @return string New token
4788 protected function confirmationToken( &$expiration ) {
4789 global $wgUserEmailConfirmationTokenExpiry;
4791 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4792 $expiration = wfTimestamp( TS_MW
, $expires );
4794 $token = MWCryptRand
::generateHex( 32 );
4795 $hash = md5( $token );
4796 $this->mEmailToken
= $hash;
4797 $this->mEmailTokenExpires
= $expiration;
4802 * Return a URL the user can use to confirm their email address.
4803 * @param string $token Accepts the email confirmation token
4804 * @return string New token URL
4806 protected function confirmationTokenUrl( $token ) {
4807 return $this->getTokenUrl( 'ConfirmEmail', $token );
4811 * Return a URL the user can use to invalidate their email address.
4812 * @param string $token Accepts the email confirmation token
4813 * @return string New token URL
4815 protected function invalidationTokenUrl( $token ) {
4816 return $this->getTokenUrl( 'InvalidateEmail', $token );
4820 * Internal function to format the e-mail validation/invalidation URLs.
4821 * This uses a quickie hack to use the
4822 * hardcoded English names of the Special: pages, for ASCII safety.
4824 * @note Since these URLs get dropped directly into emails, using the
4825 * short English names avoids insanely long URL-encoded links, which
4826 * also sometimes can get corrupted in some browsers/mailers
4827 * (T8957 with Gmail and Internet Explorer).
4829 * @param string $page Special page
4830 * @param string $token
4831 * @return string Formatted URL
4833 protected function getTokenUrl( $page, $token ) {
4834 // Hack to bypass localization of 'Special:'
4835 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4836 return $title->getCanonicalURL();
4840 * Mark the e-mail address confirmed.
4842 * @note Call saveSettings() after calling this function to commit the change.
4846 public function confirmEmail() {
4847 // Check if it's already confirmed, so we don't touch the database
4848 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4849 if ( !$this->isEmailConfirmed() ) {
4850 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4851 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4857 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4858 * address if it was already confirmed.
4860 * @note Call saveSettings() after calling this function to commit the change.
4861 * @return bool Returns true
4863 public function invalidateEmail() {
4865 $this->mEmailToken
= null;
4866 $this->mEmailTokenExpires
= null;
4867 $this->setEmailAuthenticationTimestamp( null );
4869 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4874 * Set the e-mail authentication timestamp.
4875 * @param string $timestamp TS_MW timestamp
4877 public function setEmailAuthenticationTimestamp( $timestamp ) {
4879 $this->mEmailAuthenticated
= $timestamp;
4880 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4884 * Is this user allowed to send e-mails within limits of current
4885 * site configuration?
4888 public function canSendEmail() {
4889 global $wgEnableEmail, $wgEnableUserEmail;
4890 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4893 $canSend = $this->isEmailConfirmed();
4894 // Avoid PHP 7.1 warning of passing $this by reference
4896 Hooks
::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
4901 * Is this user allowed to receive e-mails within limits of current
4902 * site configuration?
4905 public function canReceiveEmail() {
4906 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4910 * Is this user's e-mail address valid-looking and confirmed within
4911 * limits of the current site configuration?
4913 * @note If $wgEmailAuthentication is on, this may require the user to have
4914 * confirmed their address by returning a code or using a password
4915 * sent to the address from the wiki.
4919 public function isEmailConfirmed() {
4920 global $wgEmailAuthentication;
4922 // Avoid PHP 7.1 warning of passing $this by reference
4925 if ( Hooks
::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
4926 if ( $this->isAnon() ) {
4929 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4932 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4942 * Check whether there is an outstanding request for e-mail confirmation.
4945 public function isEmailConfirmationPending() {
4946 global $wgEmailAuthentication;
4947 return $wgEmailAuthentication &&
4948 !$this->isEmailConfirmed() &&
4949 $this->mEmailToken
&&
4950 $this->mEmailTokenExpires
> wfTimestamp();
4954 * Get the timestamp of account creation.
4956 * @return string|bool|null Timestamp of account creation, false for
4957 * non-existent/anonymous user accounts, or null if existing account
4958 * but information is not in database.
4960 public function getRegistration() {
4961 if ( $this->isAnon() ) {
4965 return $this->mRegistration
;
4969 * Get the timestamp of the first edit
4971 * @return string|bool Timestamp of first edit, or false for
4972 * non-existent/anonymous user accounts.
4974 public function getFirstEditTimestamp() {
4975 return $this->getEditTimestamp( true );
4979 * Get the timestamp of the latest edit
4982 * @return string|bool Timestamp of first edit, or false for
4983 * non-existent/anonymous user accounts.
4985 public function getLatestEditTimestamp() {
4986 return $this->getEditTimestamp( false );
4990 * Get the timestamp of the first or latest edit
4992 * @param bool $first True for the first edit, false for the latest one
4993 * @return string|bool Timestamp of first or latest edit, or false for
4994 * non-existent/anonymous user accounts.
4996 private function getEditTimestamp( $first ) {
4997 if ( $this->getId() == 0 ) {
4998 return false; // anons
5000 $dbr = wfGetDB( DB_REPLICA
);
5001 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5002 $tsField = isset( $actorWhere['tables']['temp_rev_user'] )
5003 ?
'revactor_timestamp' : 'rev_timestamp';
5004 $sortOrder = $first ?
'ASC' : 'DESC';
5005 $time = $dbr->selectField(
5006 [ 'revision' ] +
$actorWhere['tables'],
5008 [ $actorWhere['conds'] ],
5010 [ 'ORDER BY' => "$tsField $sortOrder" ],
5011 $actorWhere['joins']
5014 return false; // no edits
5016 return wfTimestamp( TS_MW
, $time );
5020 * Get the permissions associated with a given list of groups
5022 * @param array $groups Array of Strings List of internal group names
5023 * @return array Array of Strings List of permission key names for given groups combined
5025 public static function getGroupPermissions( $groups ) {
5026 global $wgGroupPermissions, $wgRevokePermissions;
5028 // grant every granted permission first
5029 foreach ( $groups as $group ) {
5030 if ( isset( $wgGroupPermissions[$group] ) ) {
5031 $rights = array_merge( $rights,
5032 // array_filter removes empty items
5033 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
5036 // now revoke the revoked permissions
5037 foreach ( $groups as $group ) {
5038 if ( isset( $wgRevokePermissions[$group] ) ) {
5039 $rights = array_diff( $rights,
5040 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
5043 return array_unique( $rights );
5047 * Get all the groups who have a given permission
5049 * @param string $role Role to check
5050 * @return array Array of Strings List of internal group names with the given permission
5052 public static function getGroupsWithPermission( $role ) {
5053 global $wgGroupPermissions;
5054 $allowedGroups = [];
5055 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
5056 if ( self
::groupHasPermission( $group, $role ) ) {
5057 $allowedGroups[] = $group;
5060 return $allowedGroups;
5064 * Check, if the given group has the given permission
5066 * If you're wanting to check whether all users have a permission, use
5067 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
5071 * @param string $group Group to check
5072 * @param string $role Role to check
5075 public static function groupHasPermission( $group, $role ) {
5076 global $wgGroupPermissions, $wgRevokePermissions;
5077 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
5078 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
5082 * Check if all users may be assumed to have the given permission
5084 * We generally assume so if the right is granted to '*' and isn't revoked
5085 * on any group. It doesn't attempt to take grants or other extension
5086 * limitations on rights into account in the general case, though, as that
5087 * would require it to always return false and defeat the purpose.
5088 * Specifically, session-based rights restrictions (such as OAuth or bot
5089 * passwords) are applied based on the current session.
5092 * @param string $right Right to check
5095 public static function isEveryoneAllowed( $right ) {
5096 global $wgGroupPermissions, $wgRevokePermissions;
5099 // Use the cached results, except in unit tests which rely on
5100 // being able change the permission mid-request
5101 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
5102 return $cache[$right];
5105 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
5106 $cache[$right] = false;
5110 // If it's revoked anywhere, then everyone doesn't have it
5111 foreach ( $wgRevokePermissions as $rights ) {
5112 if ( isset( $rights[$right] ) && $rights[$right] ) {
5113 $cache[$right] = false;
5118 // Remove any rights that aren't allowed to the global-session user,
5119 // unless there are no sessions for this endpoint.
5120 if ( !defined( 'MW_NO_SESSION' ) ) {
5121 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
5122 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
5123 $cache[$right] = false;
5128 // Allow extensions to say false
5129 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
5130 $cache[$right] = false;
5134 $cache[$right] = true;
5139 * Return the set of defined explicit groups.
5140 * The implicit groups (by default *, 'user' and 'autoconfirmed')
5141 * are not included, as they are defined automatically, not in the database.
5142 * @return array Array of internal group names
5144 public static function getAllGroups() {
5145 global $wgGroupPermissions, $wgRevokePermissions;
5146 return array_values( array_diff(
5147 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
5148 self
::getImplicitGroups()
5153 * Get a list of all available permissions.
5154 * @return string[] Array of permission names
5156 public static function getAllRights() {
5157 if ( self
::$mAllRights === false ) {
5158 global $wgAvailableRights;
5159 if ( count( $wgAvailableRights ) ) {
5160 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
5162 self
::$mAllRights = self
::$mCoreRights;
5164 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
5166 return self
::$mAllRights;
5170 * Get a list of implicit groups
5171 * TODO: Should we deprecate this? It's trivial, but we don't want to encourage use of globals.
5173 * @return array Array of Strings Array of internal group names
5175 public static function getImplicitGroups() {
5176 global $wgImplicitGroups;
5177 return $wgImplicitGroups;
5181 * Get the title of a page describing a particular group
5182 * @deprecated since 1.29 Use UserGroupMembership::getGroupPage instead
5184 * @param string $group Internal group name
5185 * @return Title|bool Title of the page if it exists, false otherwise
5187 public static function getGroupPage( $group ) {
5188 wfDeprecated( __METHOD__
, '1.29' );
5189 return UserGroupMembership
::getGroupPage( $group );
5193 * Create a link to the group in HTML, if available;
5194 * else return the group name.
5195 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5196 * make the link yourself if you need custom text
5198 * @param string $group Internal name of the group
5199 * @param string $text The text of the link
5200 * @return string HTML link to the group
5202 public static function makeGroupLinkHTML( $group, $text = '' ) {
5203 wfDeprecated( __METHOD__
, '1.29' );
5205 if ( $text == '' ) {
5206 $text = UserGroupMembership
::getGroupName( $group );
5208 $title = UserGroupMembership
::getGroupPage( $group );
5210 return MediaWikiServices
::getInstance()
5211 ->getLinkRenderer()->makeLink( $title, $text );
5214 return htmlspecialchars( $text );
5218 * Create a link to the group in Wikitext, if available;
5219 * else return the group name.
5220 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5221 * make the link yourself if you need custom text
5223 * @param string $group Internal name of the group
5224 * @param string $text The text of the link
5225 * @return string Wikilink to the group
5227 public static function makeGroupLinkWiki( $group, $text = '' ) {
5228 wfDeprecated( __METHOD__
, '1.29' );
5230 if ( $text == '' ) {
5231 $text = UserGroupMembership
::getGroupName( $group );
5233 $title = UserGroupMembership
::getGroupPage( $group );
5235 $page = $title->getFullText();
5236 return "[[$page|$text]]";
5243 * Returns an array of the groups that a particular group can add/remove.
5245 * @param string $group The group to check for whether it can add/remove
5246 * @return array Array( 'add' => array( addablegroups ),
5247 * 'remove' => array( removablegroups ),
5248 * 'add-self' => array( addablegroups to self),
5249 * 'remove-self' => array( removable groups from self) )
5251 public static function changeableByGroup( $group ) {
5252 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
5261 if ( empty( $wgAddGroups[$group] ) ) {
5262 // Don't add anything to $groups
5263 } elseif ( $wgAddGroups[$group] === true ) {
5264 // You get everything
5265 $groups['add'] = self
::getAllGroups();
5266 } elseif ( is_array( $wgAddGroups[$group] ) ) {
5267 $groups['add'] = $wgAddGroups[$group];
5270 // Same thing for remove
5271 if ( empty( $wgRemoveGroups[$group] ) ) {
5273 } elseif ( $wgRemoveGroups[$group] === true ) {
5274 $groups['remove'] = self
::getAllGroups();
5275 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
5276 $groups['remove'] = $wgRemoveGroups[$group];
5279 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
5280 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
5281 foreach ( $wgGroupsAddToSelf as $key => $value ) {
5282 if ( is_int( $key ) ) {
5283 $wgGroupsAddToSelf['user'][] = $value;
5288 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
5289 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
5290 if ( is_int( $key ) ) {
5291 $wgGroupsRemoveFromSelf['user'][] = $value;
5296 // Now figure out what groups the user can add to him/herself
5297 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
5299 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
5300 // No idea WHY this would be used, but it's there
5301 $groups['add-self'] = self
::getAllGroups();
5302 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
5303 $groups['add-self'] = $wgGroupsAddToSelf[$group];
5306 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
5308 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
5309 $groups['remove-self'] = self
::getAllGroups();
5310 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
5311 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
5318 * Returns an array of groups that this user can add and remove
5319 * @return array Array( 'add' => array( addablegroups ),
5320 * 'remove' => array( removablegroups ),
5321 * 'add-self' => array( addablegroups to self),
5322 * 'remove-self' => array( removable groups from self) )
5324 public function changeableGroups() {
5325 if ( $this->isAllowed( 'userrights' ) ) {
5326 // This group gives the right to modify everything (reverse-
5327 // compatibility with old "userrights lets you change
5329 // Using array_merge to make the groups reindexed
5330 $all = array_merge( self
::getAllGroups() );
5339 // Okay, it's not so simple, we will have to go through the arrays
5346 $addergroups = $this->getEffectiveGroups();
5348 foreach ( $addergroups as $addergroup ) {
5349 $groups = array_merge_recursive(
5350 $groups, $this->changeableByGroup( $addergroup )
5352 $groups['add'] = array_unique( $groups['add'] );
5353 $groups['remove'] = array_unique( $groups['remove'] );
5354 $groups['add-self'] = array_unique( $groups['add-self'] );
5355 $groups['remove-self'] = array_unique( $groups['remove-self'] );
5361 * Schedule a deferred update to update the user's edit count
5363 public function incEditCount() {
5364 if ( $this->isAnon() ) {
5368 DeferredUpdates
::addUpdate(
5369 new UserEditCountUpdate( $this, 1 ),
5370 DeferredUpdates
::POSTSEND
5375 * This method should not be called outside User/UserEditCountUpdate
5379 public function setEditCountInternal( $count ) {
5380 $this->mEditCount
= $count;
5384 * Initialize user_editcount from data out of the revision table
5386 * This method should not be called outside User/UserEditCountUpdate
5388 * @return int Number of edits
5390 public function initEditCountInternal() {
5391 // Pull from a replica DB to be less cruel to servers
5392 // Accuracy isn't the point anyway here
5393 $dbr = wfGetDB( DB_REPLICA
);
5394 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5395 $count = (int)$dbr->selectField(
5396 [ 'revision' ] +
$actorWhere['tables'],
5398 [ $actorWhere['conds'] ],
5401 $actorWhere['joins']
5404 $dbw = wfGetDB( DB_MASTER
);
5407 [ 'user_editcount' => $count ],
5409 'user_id' => $this->getId(),
5410 'user_editcount IS NULL OR user_editcount < ' . (int)$count
5419 * Get the description of a given right
5422 * @param string $right Right to query
5423 * @return string Localized description of the right
5425 public static function getRightDescription( $right ) {
5426 $key = "right-$right";
5427 $msg = wfMessage( $key );
5428 return $msg->isDisabled() ?
$right : $msg->text();
5432 * Get the name of a given grant
5435 * @param string $grant Grant to query
5436 * @return string Localized name of the grant
5438 public static function getGrantName( $grant ) {
5439 $key = "grant-$grant";
5440 $msg = wfMessage( $key );
5441 return $msg->isDisabled() ?
$grant : $msg->text();
5445 * Add a newuser log entry for this user.
5446 * Before 1.19 the return value was always true.
5448 * @deprecated since 1.27, AuthManager handles logging
5449 * @param string|bool $action Account creation type.
5450 * - String, one of the following values:
5451 * - 'create' for an anonymous user creating an account for himself.
5452 * This will force the action's performer to be the created user itself,
5453 * no matter the value of $wgUser
5454 * - 'create2' for a logged in user creating an account for someone else
5455 * - 'byemail' when the created user will receive its password by e-mail
5456 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5457 * - Boolean means whether the account was created by e-mail (deprecated):
5458 * - true will be converted to 'byemail'
5459 * - false will be converted to 'create' if this object is the same as
5460 * $wgUser and to 'create2' otherwise
5461 * @param string $reason User supplied reason
5464 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5465 return true; // disabled
5469 * Add an autocreate newuser log entry for this user
5470 * Used by things like CentralAuth and perhaps other authplugins.
5471 * Consider calling addNewUserLogEntry() directly instead.
5473 * @deprecated since 1.27, AuthManager handles logging
5476 public function addNewUserLogEntryAutoCreate() {
5477 $this->addNewUserLogEntry( 'autocreate' );
5483 * Load the user options either from cache, the database or an array
5485 * @param array|null $data Rows for the current user out of the user_properties table
5487 protected function loadOptions( $data = null ) {
5490 if ( $this->mOptionsLoaded
) {
5494 $this->mOptions
= self
::getDefaultOptions();
5496 if ( !$this->getId() ) {
5497 // For unlogged-in users, load language/variant options from request.
5498 // There's no need to do it for logged-in users: they can set preferences,
5499 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5500 // so don't override user's choice (especially when the user chooses site default).
5501 $variant = MediaWikiServices
::getInstance()->getContentLanguage()->getDefaultVariant();
5502 $this->mOptions
['variant'] = $variant;
5503 $this->mOptions
['language'] = $variant;
5504 $this->mOptionsLoaded
= true;
5508 // Maybe load from the object
5509 if ( !is_null( $this->mOptionOverrides
) ) {
5510 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5511 foreach ( $this->mOptionOverrides
as $key => $value ) {
5512 $this->mOptions
[$key] = $value;
5515 if ( !is_array( $data ) ) {
5516 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5517 // Load from database
5518 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5519 ?
wfGetDB( DB_MASTER
)
5520 : wfGetDB( DB_REPLICA
);
5522 $res = $dbr->select(
5524 [ 'up_property', 'up_value' ],
5525 [ 'up_user' => $this->getId() ],
5529 $this->mOptionOverrides
= [];
5531 foreach ( $res as $row ) {
5532 // Convert '0' to 0. PHP's boolean conversion considers them both
5533 // false, but e.g. JavaScript considers the former as true.
5534 // @todo: T54542 Somehow determine the desired type (string/int/bool)
5535 // and convert all values here.
5536 if ( $row->up_value
=== '0' ) {
5539 $data[$row->up_property
] = $row->up_value
;
5543 foreach ( $data as $property => $value ) {
5544 $this->mOptionOverrides
[$property] = $value;
5545 $this->mOptions
[$property] = $value;
5549 // Replace deprecated language codes
5550 $this->mOptions
['language'] = LanguageCode
::replaceDeprecatedCodes(
5551 $this->mOptions
['language']
5554 $this->mOptionsLoaded
= true;
5556 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5560 * Saves the non-default options for this user, as previously set e.g. via
5561 * setOption(), in the database's "user_properties" (preferences) table.
5562 * Usually used via saveSettings().
5564 protected function saveOptions() {
5565 $this->loadOptions();
5567 // Not using getOptions(), to keep hidden preferences in database
5568 $saveOptions = $this->mOptions
;
5570 // Allow hooks to abort, for instance to save to a global profile.
5571 // Reset options to default state before saving.
5572 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5576 $userId = $this->getId();
5578 $insert_rows = []; // all the new preference rows
5579 foreach ( $saveOptions as $key => $value ) {
5580 // Don't bother storing default values
5581 $defaultOption = self
::getDefaultOption( $key );
5582 if ( ( $defaultOption === null && $value !== false && $value !== null )
5583 ||
$value != $defaultOption
5586 'up_user' => $userId,
5587 'up_property' => $key,
5588 'up_value' => $value,
5593 $dbw = wfGetDB( DB_MASTER
);
5595 $res = $dbw->select( 'user_properties',
5596 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5598 // Find prior rows that need to be removed or updated. These rows will
5599 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5601 foreach ( $res as $row ) {
5602 if ( !isset( $saveOptions[$row->up_property
] )
5603 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5605 $keysDelete[] = $row->up_property
;
5609 if ( count( $keysDelete ) ) {
5610 // Do the DELETE by PRIMARY KEY for prior rows.
5611 // In the past a very large portion of calls to this function are for setting
5612 // 'rememberpassword' for new accounts (a preference that has since been removed).
5613 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5614 // caused gap locks on [max user ID,+infinity) which caused high contention since
5615 // updates would pile up on each other as they are for higher (newer) user IDs.
5616 // It might not be necessary these days, but it shouldn't hurt either.
5617 $dbw->delete( 'user_properties',
5618 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5620 // Insert the new preference rows
5621 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5625 * Return the list of user fields that should be selected to create
5626 * a new user object.
5627 * @deprecated since 1.31, use self::getQueryInfo() instead.
5630 public static function selectFields() {
5631 wfDeprecated( __METHOD__
, '1.31' );
5639 'user_email_authenticated',
5641 'user_email_token_expires',
5642 'user_registration',
5648 * Return the tables, fields, and join conditions to be selected to create
5649 * a new user object.
5651 * @return array With three keys:
5652 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
5653 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
5654 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
5656 public static function getQueryInfo() {
5657 global $wgActorTableSchemaMigrationStage;
5660 'tables' => [ 'user' ],
5668 'user_email_authenticated',
5670 'user_email_token_expires',
5671 'user_registration',
5677 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
5678 // but it does little harm and might be needed for write callers loading a User.
5679 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
5680 $ret['tables']['user_actor'] = 'actor';
5681 $ret['fields'][] = 'user_actor.actor_id';
5682 $ret['joins']['user_actor'] = [
5683 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) ?
'JOIN' : 'LEFT JOIN',
5684 [ 'user_actor.actor_user = user_id' ]
5692 * Factory function for fatal permission-denied errors
5695 * @param string $permission User right required
5698 static function newFatalPermissionDeniedStatus( $permission ) {
5702 foreach ( self
::getGroupsWithPermission( $permission ) as $group ) {
5703 $groups[] = UserGroupMembership
::getLink( $group, RequestContext
::getMain(), 'wiki' );
5707 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5710 return Status
::newFatal( 'badaccess-group0' );
5714 * Get a new instance of this user that was loaded from the master via a locking read
5716 * Use this instead of the main context User when updating that user. This avoids races
5717 * where that user was loaded from a replica DB or even the master but without proper locks.
5719 * @return User|null Returns null if the user was not found in the DB
5722 public function getInstanceForUpdate() {
5723 if ( !$this->getId() ) {
5724 return null; // anon
5727 $user = self
::newFromId( $this->getId() );
5728 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5736 * Checks if two user objects point to the same user.
5738 * @since 1.25 ; takes a UserIdentity instead of a User since 1.32
5739 * @param UserIdentity $user
5742 public function equals( UserIdentity
$user ) {
5743 // XXX it's not clear whether central ID providers are supposed to obey this
5744 return $this->getName() === $user->getName();