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
;
32 use Wikimedia\ScopedCallback
;
33 use Wikimedia\Rdbms\Database
;
34 use Wikimedia\Rdbms\DBExpectedError
;
35 use Wikimedia\Rdbms\IDatabase
;
38 * The User object encapsulates all of the user-specific settings (user_id,
39 * name, rights, email address, options, last login time). Client
40 * classes use the getXXX() functions to access these fields. These functions
41 * do all the work of determining whether the user is logged in,
42 * whether the requested option can be satisfied from cookies or
43 * whether a database query is needed. Most of the settings needed
44 * for rendering normal pages are set in the cookie to minimize use
47 class User
implements IDBAccessObject
, UserIdentity
{
49 * @const int Number of characters in user_token field.
51 const TOKEN_LENGTH
= 32;
54 * @const string An invalid value for user_token
56 const INVALID_TOKEN
= '*** INVALID ***';
59 * @const int Serialized record version.
64 * Exclude user options that are set to their default value.
67 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
72 const CHECK_USER_RIGHTS
= true;
77 const IGNORE_USER_RIGHTS
= false;
80 * Array of Strings List of member variables which are saved to the
81 * shared cache (memcached). Any operation which changes the
82 * corresponding database fields must call a cache-clearing function.
85 protected static $mCacheVars = [
93 'mEmailAuthenticated',
100 // user_properties table
107 * Array of Strings Core rights.
108 * Each of these should have a corresponding message of the form
112 protected static $mCoreRights = [
160 'move-categorypages',
161 'move-rootuserpages',
165 'override-export-depth',
187 'userrights-interwiki',
195 * String Cached results of getAllRights()
197 protected static $mAllRights = false;
199 /** Cache variables */
212 /** @var string TS_MW timestamp from the DB */
214 /** @var string TS_MW timestamp from cache */
215 protected $mQuickTouched;
219 public $mEmailAuthenticated;
221 protected $mEmailToken;
223 protected $mEmailTokenExpires;
225 protected $mRegistration;
227 protected $mEditCount;
228 /** @var UserGroupMembership[] Associative array of (group name => UserGroupMembership object) */
229 protected $mGroupMemberships;
231 protected $mOptionOverrides;
235 * Bool Whether the cache variables have been loaded.
238 public $mOptionsLoaded;
241 * Array with already loaded items or true if all items have been loaded.
243 protected $mLoadedItems = [];
247 * String Initialization data source if mLoadedItems!==true. May be one of:
248 * - 'defaults' anonymous user initialised from class defaults
249 * - 'name' initialise from mName
250 * - 'id' initialise from mId
251 * - 'actor' initialise from mActorId
252 * - 'session' log in from session if possible
254 * Use the User::newFrom*() family of functions to set this.
259 * Lazy-initialized variables, invalidated with clearInstanceCache
263 protected $mDatePreference;
271 protected $mBlockreason;
273 protected $mEffectiveGroups;
275 protected $mImplicitGroups;
277 protected $mFormerGroups;
279 protected $mGlobalBlock;
287 /** @var WebRequest */
294 protected $mAllowUsertalk;
297 private $mBlockedFromCreateAccount = false;
299 /** @var int User::READ_* constant bitfield used to load data */
300 protected $queryFlagsUsed = self
::READ_NORMAL
;
302 public static $idCacheByName = [];
305 * Lightweight constructor for an anonymous user.
306 * Use the User::newFrom* factory functions for other kinds of users.
310 * @see newFromActorId()
311 * @see newFromConfirmationCode()
312 * @see newFromSession()
315 public function __construct() {
316 $this->clearInstanceCache( 'defaults' );
322 public function __toString() {
323 return (string)$this->getName();
327 * Test if it's safe to load this User object.
329 * You should typically check this before using $wgUser or
330 * RequestContext::getUser in a method that might be called before the
331 * system has been fully initialized. If the object is unsafe, you should
332 * use an anonymous user:
334 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
340 public function isSafeToLoad() {
341 global $wgFullyInitialised;
343 // The user is safe to load if:
344 // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
345 // * mLoadedItems === true (already loaded)
346 // * mFrom !== 'session' (sessions not involved at all)
348 return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
349 $this->mLoadedItems
=== true ||
$this->mFrom
!== 'session';
353 * Load the user table data for this object from the source given by mFrom.
355 * @param int $flags User::READ_* constant bitfield
357 public function load( $flags = self
::READ_NORMAL
) {
358 global $wgFullyInitialised;
360 if ( $this->mLoadedItems
=== true ) {
364 // Set it now to avoid infinite recursion in accessors
365 $oldLoadedItems = $this->mLoadedItems
;
366 $this->mLoadedItems
= true;
367 $this->queryFlagsUsed
= $flags;
369 // If this is called too early, things are likely to break.
370 if ( !$wgFullyInitialised && $this->mFrom
=== 'session' ) {
371 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
372 ->warning( 'User::loadFromSession called before the end of Setup.php', [
373 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
375 $this->loadDefaults();
376 $this->mLoadedItems
= $oldLoadedItems;
380 switch ( $this->mFrom
) {
382 $this->loadDefaults();
385 // Make sure this thread sees its own changes
386 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
387 if ( $lb->hasOrMadeRecentMasterChanges() ) {
388 $flags |
= self
::READ_LATEST
;
389 $this->queryFlagsUsed
= $flags;
392 $this->mId
= self
::idFromName( $this->mName
, $flags );
394 // Nonexistent user placeholder object
395 $this->loadDefaults( $this->mName
);
397 $this->loadFromId( $flags );
401 // Make sure this thread sees its own changes, if the ID isn't 0
402 if ( $this->mId
!= 0 ) {
403 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
404 if ( $lb->hasOrMadeRecentMasterChanges() ) {
405 $flags |
= self
::READ_LATEST
;
406 $this->queryFlagsUsed
= $flags;
410 $this->loadFromId( $flags );
413 // Make sure this thread sees its own changes
414 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
415 if ( $lb->hasOrMadeRecentMasterChanges() ) {
416 $flags |
= self
::READ_LATEST
;
417 $this->queryFlagsUsed
= $flags;
420 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
421 $row = wfGetDB( $index )->selectRow(
423 [ 'actor_user', 'actor_name' ],
424 [ 'actor_id' => $this->mActorId
],
431 $this->loadDefaults();
432 } elseif ( $row->actor_user
) {
433 $this->mId
= $row->actor_user
;
434 $this->loadFromId( $flags );
436 $this->loadDefaults( $row->actor_name
);
440 if ( !$this->loadFromSession() ) {
441 // Loading from session failed. Load defaults.
442 $this->loadDefaults();
444 Hooks
::run( 'UserLoadAfterLoadFromSession', [ $this ] );
447 throw new UnexpectedValueException(
448 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
453 * Load user table data, given mId has already been set.
454 * @param int $flags User::READ_* constant bitfield
455 * @return bool False if the ID does not exist, true otherwise
457 public function loadFromId( $flags = self
::READ_NORMAL
) {
458 if ( $this->mId
== 0 ) {
459 // Anonymous users are not in the database (don't need cache)
460 $this->loadDefaults();
464 // Try cache (unless this needs data from the master DB).
465 // NOTE: if this thread called saveSettings(), the cache was cleared.
466 $latest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
468 if ( !$this->loadFromDatabase( $flags ) ) {
469 // Can't load from ID
473 $this->loadFromCache();
476 $this->mLoadedItems
= true;
477 $this->queryFlagsUsed
= $flags;
484 * @param string $wikiId
487 public static function purge( $wikiId, $userId ) {
488 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
489 $key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
490 $cache->delete( $key );
495 * @param WANObjectCache $cache
498 protected function getCacheKey( WANObjectCache
$cache ) {
499 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
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 = ObjectCache
::getMainWANInstance();
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 ) {
593 // Create unloaded user object
597 $u->setItemLoaded( 'name' );
603 * Static factory method for creation from a given user ID.
605 * @param int $id Valid user ID
606 * @return User The corresponding User object
608 public static function newFromId( $id ) {
612 $u->setItemLoaded( 'id' );
617 * Static factory method for creation from a given actor ID.
620 * @param int $id Valid actor ID
621 * @return User The corresponding User object
623 public static function newFromActorId( $id ) {
624 global $wgActorTableSchemaMigrationStage;
626 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
627 // but it does little harm and might be needed for write callers loading a User.
628 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) ) {
629 throw new BadMethodCallException(
630 'Cannot use ' . __METHOD__
631 . ' when $wgActorTableSchemaMigrationStage lacks SCHEMA_COMPAT_NEW'
638 $u->setItemLoaded( 'actor' );
643 * Returns a User object corresponding to the given UserIdentity.
647 * @param UserIdentity $identity
651 public static function newFromIdentity( UserIdentity
$identity ) {
652 if ( $identity instanceof User
) {
656 return self
::newFromAnyId(
657 $identity->getId() === 0 ?
null : $identity->getId(),
658 $identity->getName() === '' ?
null : $identity->getName(),
659 $identity->getActorId() === 0 ?
null : $identity->getActorId()
664 * Static factory method for creation from an ID, name, and/or actor ID
666 * This does not check that the ID, name, and actor ID all correspond to
670 * @param int|null $userId User ID, if known
671 * @param string|null $userName User name, if known
672 * @param int|null $actorId Actor ID, if known
675 public static function newFromAnyId( $userId, $userName, $actorId ) {
676 global $wgActorTableSchemaMigrationStage;
679 $user->mFrom
= 'defaults';
681 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
682 // but it does little harm and might be needed for write callers loading a User.
683 if ( ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) && $actorId !== null ) {
684 $user->mActorId
= (int)$actorId;
685 if ( $user->mActorId
!== 0 ) {
686 $user->mFrom
= 'actor';
688 $user->setItemLoaded( 'actor' );
691 if ( $userName !== null && $userName !== '' ) {
692 $user->mName
= $userName;
693 $user->mFrom
= 'name';
694 $user->setItemLoaded( 'name' );
697 if ( $userId !== null ) {
698 $user->mId
= (int)$userId;
699 if ( $user->mId
!== 0 ) {
702 $user->setItemLoaded( 'id' );
705 if ( $user->mFrom
=== 'defaults' ) {
706 throw new InvalidArgumentException(
707 'Cannot create a user with no name, no ID, and no actor ID'
715 * Factory method to fetch whichever user has a given email confirmation code.
716 * This code is generated when an account is created or its e-mail address
719 * If the code is invalid or has expired, returns NULL.
721 * @param string $code Confirmation code
722 * @param int $flags User::READ_* bitfield
725 public static function newFromConfirmationCode( $code, $flags = 0 ) {
726 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
727 ?
wfGetDB( DB_MASTER
)
728 : wfGetDB( DB_REPLICA
);
730 $id = $db->selectField(
734 'user_email_token' => md5( $code ),
735 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
739 return $id ? self
::newFromId( $id ) : null;
743 * Create a new user object using data from session. If the login
744 * credentials are invalid, the result is an anonymous user.
746 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
749 public static function newFromSession( WebRequest
$request = null ) {
751 $user->mFrom
= 'session';
752 $user->mRequest
= $request;
757 * Create a new user object from a user row.
758 * The row should have the following fields from the user table in it:
759 * - either user_name or user_id to load further data if needed (or both)
761 * - all other fields (email, etc.)
762 * It is useless to provide the remaining fields if either user_id,
763 * user_name and user_real_name are not provided because the whole row
764 * will be loaded once more from the database when accessing them.
766 * @param stdClass $row A row from the user table
767 * @param array|null $data Further data to load into the object
768 * (see User::loadFromRow for valid keys)
771 public static function newFromRow( $row, $data = null ) {
773 $user->loadFromRow( $row, $data );
778 * Static factory method for creation of a "system" user from username.
780 * A "system" user is an account that's used to attribute logged actions
781 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
782 * might include the 'Maintenance script' or 'Conversion script' accounts
783 * used by various scripts in the maintenance/ directory or accounts such
784 * as 'MediaWiki message delivery' used by the MassMessage extension.
786 * This can optionally create the user if it doesn't exist, and "steal" the
787 * account if it does exist.
789 * "Stealing" an existing user is intended to make it impossible for normal
790 * authentication processes to use the account, effectively disabling the
791 * account for normal use:
792 * - Email is invalidated, to prevent account recovery by emailing a
793 * temporary password and to disassociate the account from the existing
795 * - The token is set to a magic invalid value, to kill existing sessions
796 * and to prevent $this->setToken() calls from resetting the token to a
798 * - SessionManager is instructed to prevent new sessions for the user, to
799 * do things like deauthorizing OAuth consumers.
800 * - AuthManager is instructed to revoke access, to invalidate or remove
801 * passwords and other credentials.
803 * @param string $name Username
804 * @param array $options Options are:
805 * - validate: As for User::getCanonicalName(), default 'valid'
806 * - create: Whether to create the user if it doesn't already exist, default true
807 * - steal: Whether to "disable" the account for normal use if it already
808 * exists, default false
812 public static function newSystemUser( $name, $options = [] ) {
814 'validate' => 'valid',
819 $name = self
::getCanonicalName( $name, $options['validate'] );
820 if ( $name === false ) {
824 $dbr = wfGetDB( DB_REPLICA
);
825 $userQuery = self
::getQueryInfo();
826 $row = $dbr->selectRow(
827 $userQuery['tables'],
828 $userQuery['fields'],
829 [ 'user_name' => $name ],
835 // Try the master database...
836 $dbw = wfGetDB( DB_MASTER
);
837 $row = $dbw->selectRow(
838 $userQuery['tables'],
839 $userQuery['fields'],
840 [ 'user_name' => $name ],
848 // No user. Create it?
849 return $options['create']
850 ? self
::createNew( $name, [ 'token' => self
::INVALID_TOKEN
] )
854 $user = self
::newFromRow( $row );
856 // A user is considered to exist as a non-system user if it can
857 // authenticate, or has an email set, or has a non-invalid token.
858 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
859 AuthManager
::singleton()->userCanAuthenticate( $name )
861 // User exists. Steal it?
862 if ( !$options['steal'] ) {
866 AuthManager
::singleton()->revokeAccessForUser( $name );
868 $user->invalidateEmail();
869 $user->mToken
= self
::INVALID_TOKEN
;
870 $user->saveSettings();
871 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
880 * Get the username corresponding to a given user ID
881 * @param int $id User ID
882 * @return string|bool The corresponding username
884 public static function whoIs( $id ) {
885 return UserCache
::singleton()->getProp( $id, 'name' );
889 * Get the real name of a user given their user ID
891 * @param int $id User ID
892 * @return string|bool The corresponding user's real name
894 public static function whoIsReal( $id ) {
895 return UserCache
::singleton()->getProp( $id, 'real_name' );
899 * Get database id given a user name
900 * @param string $name Username
901 * @param int $flags User::READ_* constant bitfield
902 * @return int|null The corresponding user's ID, or null if user is nonexistent
904 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
905 // Don't explode on self::$idCacheByName[$name] if $name is not a string but e.g. a User object
906 $name = (string)$name;
907 $nt = Title
::makeTitleSafe( NS_USER
, $name );
908 if ( is_null( $nt ) ) {
913 if ( !( $flags & self
::READ_LATEST
) && array_key_exists( $name, self
::$idCacheByName ) ) {
914 return self
::$idCacheByName[$name];
917 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
918 $db = wfGetDB( $index );
923 [ 'user_name' => $nt->getText() ],
928 if ( $s === false ) {
931 $result = (int)$s->user_id
;
934 self
::$idCacheByName[$name] = $result;
936 if ( count( self
::$idCacheByName ) > 1000 ) {
937 self
::$idCacheByName = [];
944 * Reset the cache used in idFromName(). For use in tests.
946 public static function resetIdByNameCache() {
947 self
::$idCacheByName = [];
951 * Does the string match an anonymous IP address?
953 * This function exists for username validation, in order to reject
954 * usernames which are similar in form to IP addresses. Strings such
955 * as 300.300.300.300 will return true because it looks like an IP
956 * address, despite not being strictly valid.
958 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
959 * address because the usemod software would "cloak" anonymous IP
960 * addresses like this, if we allowed accounts like this to be created
961 * new users could get the old edits of these anonymous users.
963 * @param string $name Name to match
966 public static function isIP( $name ) {
967 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
968 || IP
::isIPv6( $name );
972 * Is the user an IP range?
977 public function isIPRange() {
978 return IP
::isValidRange( $this->mName
);
982 * Is the input a valid username?
984 * Checks if the input is a valid username, we don't want an empty string,
985 * an IP address, anything that contains slashes (would mess up subpages),
986 * is longer than the maximum allowed username size or doesn't begin with
989 * @param string $name Name to match
992 public static function isValidUserName( $name ) {
993 global $wgMaxNameChars;
996 || self
::isIP( $name )
997 ||
strpos( $name, '/' ) !== false
998 ||
strlen( $name ) > $wgMaxNameChars
999 ||
$name != MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name )
1004 // Ensure that the name can't be misresolved as a different title,
1005 // such as with extra namespace keys at the start.
1006 $parsed = Title
::newFromText( $name );
1007 if ( is_null( $parsed )
1008 ||
$parsed->getNamespace()
1009 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
1013 // Check an additional blacklist of troublemaker characters.
1014 // Should these be merged into the title char list?
1015 $unicodeBlacklist = '/[' .
1016 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
1017 '\x{00a0}' . # non-breaking space
1018 '\x{2000}-\x{200f}' . # various whitespace
1019 '\x{2028}-\x{202f}' . # breaks and control chars
1020 '\x{3000}' . # ideographic space
1021 '\x{e000}-\x{f8ff}' . # private use
1023 if ( preg_match( $unicodeBlacklist, $name ) ) {
1031 * Usernames which fail to pass this function will be blocked
1032 * from user login and new account registrations, but may be used
1033 * internally by batch processes.
1035 * If an account already exists in this form, login will be blocked
1036 * by a failure to pass this function.
1038 * @param string $name Name to match
1041 public static function isUsableName( $name ) {
1042 global $wgReservedUsernames;
1043 // Must be a valid username, obviously ;)
1044 if ( !self
::isValidUserName( $name ) ) {
1048 static $reservedUsernames = false;
1049 if ( !$reservedUsernames ) {
1050 $reservedUsernames = $wgReservedUsernames;
1051 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
1054 // Certain names may be reserved for batch processes.
1055 foreach ( $reservedUsernames as $reserved ) {
1056 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
1057 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->plain();
1059 if ( $reserved == $name ) {
1067 * Return the users who are members of the given group(s). In case of multiple groups,
1068 * users who are members of at least one of them are returned.
1070 * @param string|array $groups A single group name or an array of group names
1071 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
1072 * records; larger values are ignored.
1073 * @param int|null $after ID the user to start after
1074 * @return UserArrayFromResult
1076 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
1077 if ( $groups === [] ) {
1078 return UserArrayFromResult
::newFromIDs( [] );
1081 $groups = array_unique( (array)$groups );
1082 $limit = min( 5000, $limit );
1084 $conds = [ 'ug_group' => $groups ];
1085 if ( $after !== null ) {
1086 $conds[] = 'ug_user > ' . (int)$after;
1089 $dbr = wfGetDB( DB_REPLICA
);
1090 $ids = $dbr->selectFieldValues(
1097 'ORDER BY' => 'ug_user',
1101 return UserArray
::newFromIDs( $ids );
1105 * Usernames which fail to pass this function will be blocked
1106 * from new account registrations, but may be used internally
1107 * either by batch processes or by user accounts which have
1108 * already been created.
1110 * Additional blacklisting may be added here rather than in
1111 * isValidUserName() to avoid disrupting existing accounts.
1113 * @param string $name String to match
1116 public static function isCreatableName( $name ) {
1117 global $wgInvalidUsernameCharacters;
1119 // Ensure that the username isn't longer than 235 bytes, so that
1120 // (at least for the builtin skins) user javascript and css files
1121 // will work. (T25080)
1122 if ( strlen( $name ) > 235 ) {
1123 wfDebugLog( 'username', __METHOD__
.
1124 ": '$name' invalid due to length" );
1128 // Preg yells if you try to give it an empty string
1129 if ( $wgInvalidUsernameCharacters !== '' ) {
1130 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
1131 wfDebugLog( 'username', __METHOD__
.
1132 ": '$name' invalid due to wgInvalidUsernameCharacters" );
1137 return self
::isUsableName( $name );
1141 * Is the input a valid password for this user?
1143 * @param string $password Desired password
1146 public function isValidPassword( $password ) {
1147 // simple boolean wrapper for checkPasswordValidity
1148 return $this->checkPasswordValidity( $password )->isGood();
1152 * Given unvalidated password input, return error message on failure.
1154 * @param string $password Desired password
1155 * @return bool|string|array True on success, string or array of error message on failure
1156 * @deprecated since 1.33, use checkPasswordValidity
1158 public function getPasswordValidity( $password ) {
1159 wfDeprecated( __METHOD__
, '1.33' );
1161 $result = $this->checkPasswordValidity( $password );
1162 if ( $result->isGood() ) {
1166 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
1167 $messages[] = $error['message'];
1169 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
1170 $messages[] = $warning['message'];
1172 if ( count( $messages ) === 1 ) {
1173 return $messages[0];
1180 * Check if this is a valid password for this user
1182 * Returns a Status object with a set of messages describing
1183 * problems with the password. If the return status is fatal,
1184 * the action should be refused and the password should not be
1185 * checked at all (this is mainly meant for DoS mitigation).
1186 * If the return value is OK but not good, the password can be checked,
1187 * but the user should not be able to set their password to this.
1188 * The value of the returned Status object will be an array which
1189 * can have the following fields:
1190 * - forceChange (bool): if set to true, the user should not be
1191 * allowed to log with this password unless they change it during
1192 * the login process (see ResetPasswordSecondaryAuthenticationProvider).
1194 * @param string $password Desired password
1198 public function checkPasswordValidity( $password ) {
1199 global $wgPasswordPolicy;
1201 $upp = new UserPasswordPolicy(
1202 $wgPasswordPolicy['policies'],
1203 $wgPasswordPolicy['checks']
1206 $status = Status
::newGood( [] );
1207 $result = false; // init $result to false for the internal checks
1209 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1210 $status->error( $result );
1214 if ( $result === false ) {
1215 $status->merge( $upp->checkUserPassword( $this, $password ), true );
1217 } elseif ( $result === true ) {
1220 $status->error( $result );
1221 return $status; // the isValidPassword hook set a string $result and returned true
1226 * Given unvalidated user input, return a canonical username, or false if
1227 * the username is invalid.
1228 * @param string $name User input
1229 * @param string|bool $validate Type of validation to use:
1230 * - false No validation
1231 * - 'valid' Valid for batch processes
1232 * - 'usable' Valid for batch processes and login
1233 * - 'creatable' Valid for batch processes, login and account creation
1235 * @throws InvalidArgumentException
1236 * @return bool|string
1238 public static function getCanonicalName( $name, $validate = 'valid' ) {
1239 // Force usernames to capital
1240 $name = MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name );
1242 # Reject names containing '#'; these will be cleaned up
1243 # with title normalisation, but then it's too late to
1245 if ( strpos( $name, '#' ) !== false ) {
1249 // Clean up name according to title rules,
1250 // but only when validation is requested (T14654)
1251 $t = ( $validate !== false ) ?
1252 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1253 // Check for invalid titles
1254 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1258 // Reject various classes of invalid names
1259 $name = AuthManager
::callLegacyAuthPlugin(
1260 'getCanonicalName', [ $t->getText() ], $t->getText()
1263 switch ( $validate ) {
1267 if ( !self
::isValidUserName( $name ) ) {
1272 if ( !self
::isUsableName( $name ) ) {
1277 if ( !self
::isCreatableName( $name ) ) {
1282 throw new InvalidArgumentException(
1283 'Invalid parameter value for $validate in ' . __METHOD__
);
1289 * Return a random password.
1291 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1292 * @return string New random password
1294 public static function randomPassword() {
1295 global $wgMinimalPasswordLength;
1296 return PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1300 * Set cached properties to default.
1302 * @note This no longer clears uncached lazy-initialised properties;
1303 * the constructor does that instead.
1305 * @param string|bool $name
1307 public function loadDefaults( $name = false ) {
1309 $this->mName
= $name;
1310 $this->mActorId
= null;
1311 $this->mRealName
= '';
1313 $this->mOptionOverrides
= null;
1314 $this->mOptionsLoaded
= false;
1316 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1317 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1318 if ( $loggedOut !== 0 ) {
1319 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1321 $this->mTouched
= '1'; # Allow any pages to be cached
1324 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1325 $this->mEmailAuthenticated
= null;
1326 $this->mEmailToken
= '';
1327 $this->mEmailTokenExpires
= null;
1328 $this->mRegistration
= wfTimestamp( TS_MW
);
1329 $this->mGroupMemberships
= [];
1331 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1335 * Return whether an item has been loaded.
1337 * @param string $item Item to check. Current possibilities:
1341 * @param string $all 'all' to check if the whole object has been loaded
1342 * or any other string to check if only the item is available (e.g.
1346 public function isItemLoaded( $item, $all = 'all' ) {
1347 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1348 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1352 * Set that an item has been loaded
1354 * @param string $item
1356 protected function setItemLoaded( $item ) {
1357 if ( is_array( $this->mLoadedItems
) ) {
1358 $this->mLoadedItems
[$item] = true;
1363 * Load user data from the session.
1365 * @return bool True if the user is logged in, false otherwise.
1367 private function loadFromSession() {
1370 Hooks
::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1371 if ( $result !== null ) {
1375 // MediaWiki\Session\Session already did the necessary authentication of the user
1376 // returned here, so just use it if applicable.
1377 $session = $this->getRequest()->getSession();
1378 $user = $session->getUser();
1379 if ( $user->isLoggedIn() ) {
1380 $this->loadFromUserObject( $user );
1381 if ( $user->isBlocked() ) {
1382 // If this user is autoblocked, set a cookie to track the Block. This has to be done on
1383 // every session load, because an autoblocked editor might not edit again from the same
1384 // IP address after being blocked.
1385 $this->trackBlockWithCookie();
1388 // Other code expects these to be set in the session, so set them.
1389 $session->set( 'wsUserID', $this->getId() );
1390 $session->set( 'wsUserName', $this->getName() );
1391 $session->set( 'wsToken', $this->getToken() );
1400 * Set the 'BlockID' cookie depending on block type and user authentication status.
1402 public function trackBlockWithCookie() {
1403 $block = $this->getBlock();
1404 if ( $block && $this->getRequest()->getCookie( 'BlockID' ) === null ) {
1405 $config = RequestContext
::getMain()->getConfig();
1406 $shouldSetCookie = false;
1408 if ( $this->isAnon() && $config->get( 'CookieSetOnIpBlock' ) ) {
1409 // If user is logged-out, set a cookie to track the Block
1410 $shouldSetCookie = in_array( $block->getType(), [
1411 Block
::TYPE_IP
, Block
::TYPE_RANGE
1413 if ( $shouldSetCookie ) {
1414 $block->setCookie( $this->getRequest()->response() );
1416 // temporary measure the use of cookies on ip blocks
1417 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1418 $stats->increment( 'block.ipblock.setCookie.success' );
1420 } elseif ( $this->isLoggedIn() && $config->get( 'CookieSetOnAutoblock' ) ) {
1421 $shouldSetCookie = $block->getType() === Block
::TYPE_USER
&& $block->isAutoblocking();
1422 if ( $shouldSetCookie ) {
1423 $block->setCookie( $this->getRequest()->response() );
1430 * Load user and user_group data from the database.
1431 * $this->mId must be set, this is how the user is identified.
1433 * @param int $flags User::READ_* constant bitfield
1434 * @return bool True if the user exists, false if the user is anonymous
1436 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1438 $this->mId
= intval( $this->mId
);
1440 if ( !$this->mId
) {
1441 // Anonymous users are not in the database
1442 $this->loadDefaults();
1446 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1447 $db = wfGetDB( $index );
1449 $userQuery = self
::getQueryInfo();
1450 $s = $db->selectRow(
1451 $userQuery['tables'],
1452 $userQuery['fields'],
1453 [ 'user_id' => $this->mId
],
1459 $this->queryFlagsUsed
= $flags;
1460 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1462 if ( $s !== false ) {
1463 // Initialise user table data
1464 $this->loadFromRow( $s );
1465 $this->mGroupMemberships
= null; // deferred
1466 $this->getEditCount(); // revalidation for nulls
1471 $this->loadDefaults();
1477 * Initialize this object from a row from the user table.
1479 * @param stdClass $row Row from the user table to load.
1480 * @param array|null $data Further user data to load into the object
1482 * user_groups Array of arrays or stdClass result rows out of the user_groups
1483 * table. Previously you were supposed to pass an array of strings
1484 * here, but we also need expiry info nowadays, so an array of
1485 * strings is ignored.
1486 * user_properties Array with properties out of the user_properties table
1488 protected function loadFromRow( $row, $data = null ) {
1489 global $wgActorTableSchemaMigrationStage;
1491 if ( !is_object( $row ) ) {
1492 throw new InvalidArgumentException( '$row must be an object' );
1497 $this->mGroupMemberships
= null; // deferred
1499 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
1500 // but it does little harm and might be needed for write callers loading a User.
1501 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
1502 if ( isset( $row->actor_id
) ) {
1503 $this->mActorId
= (int)$row->actor_id
;
1504 if ( $this->mActorId
!== 0 ) {
1505 $this->mFrom
= 'actor';
1507 $this->setItemLoaded( 'actor' );
1513 if ( isset( $row->user_name
) && $row->user_name
!== '' ) {
1514 $this->mName
= $row->user_name
;
1515 $this->mFrom
= 'name';
1516 $this->setItemLoaded( 'name' );
1521 if ( isset( $row->user_real_name
) ) {
1522 $this->mRealName
= $row->user_real_name
;
1523 $this->setItemLoaded( 'realname' );
1528 if ( isset( $row->user_id
) ) {
1529 $this->mId
= intval( $row->user_id
);
1530 if ( $this->mId
!== 0 ) {
1531 $this->mFrom
= 'id';
1533 $this->setItemLoaded( 'id' );
1538 if ( isset( $row->user_id
) && isset( $row->user_name
) && $row->user_name
!== '' ) {
1539 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1542 if ( isset( $row->user_editcount
) ) {
1543 $this->mEditCount
= $row->user_editcount
;
1548 if ( isset( $row->user_touched
) ) {
1549 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1554 if ( isset( $row->user_token
) ) {
1555 // The definition for the column is binary(32), so trim the NULs
1556 // that appends. The previous definition was char(32), so trim
1558 $this->mToken
= rtrim( $row->user_token
, " \0" );
1559 if ( $this->mToken
=== '' ) {
1560 $this->mToken
= null;
1566 if ( isset( $row->user_email
) ) {
1567 $this->mEmail
= $row->user_email
;
1568 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1569 $this->mEmailToken
= $row->user_email_token
;
1570 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1571 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1577 $this->mLoadedItems
= true;
1580 if ( is_array( $data ) ) {
1581 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1582 if ( !count( $data['user_groups'] ) ) {
1583 $this->mGroupMemberships
= [];
1585 $firstGroup = reset( $data['user_groups'] );
1586 if ( is_array( $firstGroup ) ||
is_object( $firstGroup ) ) {
1587 $this->mGroupMemberships
= [];
1588 foreach ( $data['user_groups'] as $row ) {
1589 $ugm = UserGroupMembership
::newFromRow( (object)$row );
1590 $this->mGroupMemberships
[$ugm->getGroup()] = $ugm;
1595 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1596 $this->loadOptions( $data['user_properties'] );
1602 * Load the data for this user object from another user object.
1606 protected function loadFromUserObject( $user ) {
1608 foreach ( self
::$mCacheVars as $var ) {
1609 $this->$var = $user->$var;
1614 * Load the groups from the database if they aren't already loaded.
1616 private function loadGroups() {
1617 if ( is_null( $this->mGroupMemberships
) ) {
1618 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1619 ?
wfGetDB( DB_MASTER
)
1620 : wfGetDB( DB_REPLICA
);
1621 $this->mGroupMemberships
= UserGroupMembership
::getMembershipsForUser(
1627 * Add the user to the group if he/she meets given criteria.
1629 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1630 * possible to remove manually via Special:UserRights. In such case it
1631 * will not be re-added automatically. The user will also not lose the
1632 * group if they no longer meet the criteria.
1634 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1636 * @return array Array of groups the user has been promoted to.
1638 * @see $wgAutopromoteOnce
1640 public function addAutopromoteOnceGroups( $event ) {
1641 global $wgAutopromoteOnceLogInRC;
1643 if ( wfReadOnly() ||
!$this->getId() ) {
1647 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1648 if ( !count( $toPromote ) ) {
1652 if ( !$this->checkAndSetTouched() ) {
1653 return []; // raced out (bug T48834)
1656 $oldGroups = $this->getGroups(); // previous groups
1657 $oldUGMs = $this->getGroupMemberships();
1658 foreach ( $toPromote as $group ) {
1659 $this->addGroup( $group );
1661 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1662 $newUGMs = $this->getGroupMemberships();
1664 // update groups in external authentication database
1665 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );
1666 AuthManager
::callLegacyAuthPlugin( 'updateExternalDBGroups', [ $this, $toPromote ] );
1668 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1669 $logEntry->setPerformer( $this );
1670 $logEntry->setTarget( $this->getUserPage() );
1671 $logEntry->setParameters( [
1672 '4::oldgroups' => $oldGroups,
1673 '5::newgroups' => $newGroups,
1675 $logid = $logEntry->insert();
1676 if ( $wgAutopromoteOnceLogInRC ) {
1677 $logEntry->publish( $logid );
1684 * Builds update conditions. Additional conditions may be added to $conditions to
1685 * protected against race conditions using a compare-and-set (CAS) mechanism
1686 * based on comparing $this->mTouched with the user_touched field.
1688 * @param Database $db
1689 * @param array $conditions WHERE conditions for use with Database::update
1690 * @return array WHERE conditions for use with Database::update
1692 protected function makeUpdateConditions( Database
$db, array $conditions ) {
1693 if ( $this->mTouched
) {
1694 // CAS check: only update if the row wasn't changed sicne it was loaded.
1695 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1702 * Bump user_touched if it didn't change since this object was loaded
1704 * On success, the mTouched field is updated.
1705 * The user serialization cache is always cleared.
1707 * @return bool Whether user_touched was actually updated
1710 protected function checkAndSetTouched() {
1713 if ( !$this->mId
) {
1714 return false; // anon
1717 // Get a new user_touched that is higher than the old one
1718 $newTouched = $this->newTouchedTimestamp();
1720 $dbw = wfGetDB( DB_MASTER
);
1721 $dbw->update( 'user',
1722 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1723 $this->makeUpdateConditions( $dbw, [
1724 'user_id' => $this->mId
,
1728 $success = ( $dbw->affectedRows() > 0 );
1731 $this->mTouched
= $newTouched;
1732 $this->clearSharedCache();
1734 // Clears on failure too since that is desired if the cache is stale
1735 $this->clearSharedCache( 'refresh' );
1742 * Clear various cached data stored in this object. The cache of the user table
1743 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1745 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1746 * given source. May be "name", "id", "actor", "defaults", "session", or false for no reload.
1748 public function clearInstanceCache( $reloadFrom = false ) {
1749 $this->mNewtalk
= -1;
1750 $this->mDatePreference
= null;
1751 $this->mBlockedby
= -1; # Unset
1752 $this->mHash
= false;
1753 $this->mRights
= null;
1754 $this->mEffectiveGroups
= null;
1755 $this->mImplicitGroups
= null;
1756 $this->mGroupMemberships
= null;
1757 $this->mOptions
= null;
1758 $this->mOptionsLoaded
= false;
1759 $this->mEditCount
= null;
1761 if ( $reloadFrom ) {
1762 $this->mLoadedItems
= [];
1763 $this->mFrom
= $reloadFrom;
1768 * Combine the language default options with any site-specific options
1769 * and add the default language variants.
1771 * @return array Array of String options
1773 public static function getDefaultOptions() {
1774 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgDefaultSkin;
1776 static $defOpt = null;
1777 static $defOptLang = null;
1779 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
1780 if ( $defOpt !== null && $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.
1787 $defOpt = $wgDefaultUserOptions;
1788 // Default language setting
1789 $defOptLang = $contLang->getCode();
1790 $defOpt['language'] = $defOptLang;
1791 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1792 if ( $langCode === $contLang->getCode() ) {
1793 $defOpt['variant'] = $langCode;
1795 $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 $defOpt['searchNs' . $nsnum] = (bool)$val;
1805 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1807 Hooks
::run( 'UserGetDefaultOptions', [ &$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 $bFromReplica 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( $bFromReplica = true ) {
1830 global $wgProxyWhitelist, $wgUser, $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 if ( !$this->isAllowed( 'ipblock-exempt' ) ) {
1850 // $wgUser->getName() only works after the end of Setup.php. Until
1851 // then, assume it's a logged-out user.
1852 $globalUserName = $wgUser->isSafeToLoad()
1853 ?
$wgUser->getName()
1854 : IP
::sanitizeIP( $wgUser->getRequest()->getIP() );
1855 if ( $this->getName() === $globalUserName ) {
1856 $ip = $this->getRequest()->getIP();
1861 $block = Block
::newFromTarget( $this, $ip, !$bFromReplica );
1864 if ( !$block instanceof Block
) {
1865 $block = $this->getBlockFromCookieValue( $this->getRequest()->getCookie( 'BlockID' ) );
1869 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1871 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1872 $block = new Block( [
1873 'byText' => wfMessage( 'proxyblocker' )->text(),
1874 'reason' => wfMessage( 'proxyblockreason' )->plain(),
1876 'systemBlock' => 'proxy',
1878 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1879 $block = new Block( [
1880 'byText' => wfMessage( 'sorbs' )->text(),
1881 'reason' => wfMessage( 'sorbsreason' )->plain(),
1883 'systemBlock' => 'dnsbl',
1888 // (T25343) Apply IP blocks to the contents of XFF headers, if enabled
1889 if ( !$block instanceof Block
1890 && $wgApplyIpBlocksToXff
1892 && !in_array( $ip, $wgProxyWhitelist )
1894 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1895 $xff = array_map( 'trim', explode( ',', $xff ) );
1896 $xff = array_diff( $xff, [ $ip ] );
1897 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromReplica );
1898 $block = Block
::chooseBlock( $xffblocks, $xff );
1899 if ( $block instanceof Block
) {
1900 # Mangle the reason to alert the user that the block
1901 # originated from matching the X-Forwarded-For header.
1902 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->plain();
1906 if ( !$block instanceof Block
1909 && IP
::isInRanges( $ip, $wgSoftBlockRanges )
1911 $block = new Block( [
1913 'byText' => 'MediaWiki default',
1914 'reason' => wfMessage( 'softblockrangesreason', $ip )->plain(),
1916 'systemBlock' => 'wgSoftBlockRanges',
1920 if ( $block instanceof Block
) {
1921 wfDebug( __METHOD__
. ": Found block.\n" );
1922 $this->mBlock
= $block;
1923 $this->mBlockedby
= $block->getByName();
1924 $this->mBlockreason
= $block->mReason
;
1925 $this->mHideName
= $block->mHideName
;
1926 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1928 $this->mBlock
= null;
1929 $this->mBlockedby
= '';
1930 $this->mBlockreason
= '';
1931 $this->mHideName
= 0;
1932 $this->mAllowUsertalk
= false;
1935 // Avoid PHP 7.1 warning of passing $this by reference
1938 Hooks
::run( 'GetBlockedStatus', [ &$user ] );
1942 * Try to load a Block from an ID given in a cookie value.
1943 * @param string|null $blockCookieVal The cookie value to check.
1944 * @return Block|bool The Block object, or false if none could be loaded.
1946 protected function getBlockFromCookieValue( $blockCookieVal ) {
1947 // Make sure there's something to check. The cookie value must start with a number.
1948 if ( strlen( $blockCookieVal ) < 1 ||
!is_numeric( substr( $blockCookieVal, 0, 1 ) ) ) {
1951 // Load the Block from the ID in the cookie.
1952 $blockCookieId = Block
::getIdFromCookieValue( $blockCookieVal );
1953 if ( $blockCookieId !== null ) {
1954 // An ID was found in the cookie.
1955 $tmpBlock = Block
::newFromID( $blockCookieId );
1956 if ( $tmpBlock instanceof Block
) {
1957 $config = RequestContext
::getMain()->getConfig();
1959 switch ( $tmpBlock->getType() ) {
1960 case Block
::TYPE_USER
:
1961 $blockIsValid = !$tmpBlock->isExpired() && $tmpBlock->isAutoblocking();
1962 $useBlockCookie = ( $config->get( 'CookieSetOnAutoblock' ) === true );
1964 case Block
::TYPE_IP
:
1965 case Block
::TYPE_RANGE
:
1966 // If block is type IP or IP range, load only if user is not logged in (T152462)
1967 $blockIsValid = !$tmpBlock->isExpired() && !$this->isLoggedIn();
1968 $useBlockCookie = ( $config->get( 'CookieSetOnIpBlock' ) === true );
1971 $blockIsValid = false;
1972 $useBlockCookie = false;
1975 if ( $blockIsValid && $useBlockCookie ) {
1979 // If the block is not valid, remove the cookie.
1980 Block
::clearCookie( $this->getRequest()->response() );
1983 // If the block doesn't exist, remove the cookie.
1984 Block
::clearCookie( $this->getRequest()->response() );
1991 * Whether the given IP is in a DNS blacklist.
1993 * @param string $ip IP to check
1994 * @param bool $checkWhitelist Whether to check the whitelist first
1995 * @return bool True if blacklisted.
1997 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1998 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
2000 if ( !$wgEnableDnsBlacklist ) {
2004 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
2008 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
2012 * Whether the given IP is in a given DNS blacklist.
2014 * @param string $ip IP to check
2015 * @param string|array $bases Array of Strings: URL of the DNS blacklist
2016 * @return bool True if blacklisted.
2018 public function inDnsBlacklist( $ip, $bases ) {
2020 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
2021 if ( IP
::isIPv4( $ip ) ) {
2022 // Reverse IP, T23255
2023 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
2025 foreach ( (array)$bases as $base ) {
2027 // If we have an access key, use that too (ProjectHoneypot, etc.)
2029 if ( is_array( $base ) ) {
2030 if ( count( $base ) >= 2 ) {
2031 // Access key is 1, base URL is 0
2032 $host = "{$base[1]}.$ipReversed.{$base[0]}";
2034 $host = "$ipReversed.{$base[0]}";
2036 $basename = $base[0];
2038 $host = "$ipReversed.$base";
2042 $ipList = gethostbynamel( $host );
2045 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
2049 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
2058 * Check if an IP address is in the local proxy list
2064 public static function isLocallyBlockedProxy( $ip ) {
2065 global $wgProxyList;
2067 if ( !$wgProxyList ) {
2071 if ( !is_array( $wgProxyList ) ) {
2072 // Load values from the specified file
2073 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
2076 $resultProxyList = [];
2077 $deprecatedIPEntries = [];
2079 // backward compatibility: move all ip addresses in keys to values
2080 foreach ( $wgProxyList as $key => $value ) {
2081 $keyIsIP = IP
::isIPAddress( $key );
2082 $valueIsIP = IP
::isIPAddress( $value );
2083 if ( $keyIsIP && !$valueIsIP ) {
2084 $deprecatedIPEntries[] = $key;
2085 $resultProxyList[] = $key;
2086 } elseif ( $keyIsIP && $valueIsIP ) {
2087 $deprecatedIPEntries[] = $key;
2088 $resultProxyList[] = $key;
2089 $resultProxyList[] = $value;
2091 $resultProxyList[] = $value;
2095 if ( $deprecatedIPEntries ) {
2097 'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
2098 implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
2101 $proxyListIPSet = new IPSet( $resultProxyList );
2102 return $proxyListIPSet->match( $ip );
2106 * Is this user subject to rate limiting?
2108 * @return bool True if rate limited
2110 public function isPingLimitable() {
2111 global $wgRateLimitsExcludedIPs;
2112 if ( IP
::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
2113 // No other good way currently to disable rate limits
2114 // for specific IPs. :P
2115 // But this is a crappy hack and should die.
2118 return !$this->isAllowed( 'noratelimit' );
2122 * Primitive rate limits: enforce maximum actions per time period
2123 * to put a brake on flooding.
2125 * The method generates both a generic profiling point and a per action one
2126 * (suffix being "-$action".
2128 * @note When using a shared cache like memcached, IP-address
2129 * last-hit counters will be shared across wikis.
2131 * @param string $action Action to enforce; 'edit' if unspecified
2132 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
2133 * @return bool True if a rate limiter was tripped
2135 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
2136 // Avoid PHP 7.1 warning of passing $this by reference
2138 // Call the 'PingLimiter' hook
2140 if ( !Hooks
::run( 'PingLimiter', [ &$user, $action, &$result, $incrBy ] ) ) {
2144 global $wgRateLimits;
2145 if ( !isset( $wgRateLimits[$action] ) ) {
2149 $limits = array_merge(
2150 [ '&can-bypass' => true ],
2151 $wgRateLimits[$action]
2154 // Some groups shouldn't trigger the ping limiter, ever
2155 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
2160 $id = $this->getId();
2162 $isNewbie = $this->isNewbie();
2163 $cache = ObjectCache
::getLocalClusterInstance();
2167 if ( isset( $limits['anon'] ) ) {
2168 $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
2171 // limits for logged-in users
2172 if ( isset( $limits['user'] ) ) {
2173 $userLimit = $limits['user'];
2177 // limits for anons and for newbie logged-in users
2180 if ( isset( $limits['ip'] ) ) {
2181 $ip = $this->getRequest()->getIP();
2182 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
2184 // subnet-based limits
2185 if ( isset( $limits['subnet'] ) ) {
2186 $ip = $this->getRequest()->getIP();
2187 $subnet = IP
::getSubnet( $ip );
2188 if ( $subnet !== false ) {
2189 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
2194 // Check for group-specific permissions
2195 // If more than one group applies, use the group with the highest limit ratio (max/period)
2196 foreach ( $this->getGroups() as $group ) {
2197 if ( isset( $limits[$group] ) ) {
2198 if ( $userLimit === false
2199 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
2201 $userLimit = $limits[$group];
2206 // limits for newbie logged-in users (override all the normal user limits)
2207 if ( $id !== 0 && $isNewbie && isset( $limits['newbie'] ) ) {
2208 $userLimit = $limits['newbie'];
2211 // Set the user limit key
2212 if ( $userLimit !== false ) {
2213 list( $max, $period ) = $userLimit;
2214 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
2215 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
2218 // ip-based limits for all ping-limitable users
2219 if ( isset( $limits['ip-all'] ) ) {
2220 $ip = $this->getRequest()->getIP();
2221 // ignore if user limit is more permissive
2222 if ( $isNewbie ||
$userLimit === false
2223 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
2224 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
2228 // subnet-based limits for all ping-limitable users
2229 if ( isset( $limits['subnet-all'] ) ) {
2230 $ip = $this->getRequest()->getIP();
2231 $subnet = IP
::getSubnet( $ip );
2232 if ( $subnet !== false ) {
2233 // ignore if user limit is more permissive
2234 if ( $isNewbie ||
$userLimit === false
2235 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
2236 > $userLimit[0] / $userLimit[1] ) {
2237 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
2243 foreach ( $keys as $key => $limit ) {
2244 list( $max, $period ) = $limit;
2245 $summary = "(limit $max in {$period}s)";
2246 $count = $cache->get( $key );
2249 if ( $count >= $max ) {
2250 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
2251 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
2254 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
2257 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
2258 if ( $incrBy > 0 ) {
2259 $cache->add( $key, 0, intval( $period ) ); // first ping
2262 if ( $incrBy > 0 ) {
2263 $cache->incr( $key, $incrBy );
2271 * Check if user is blocked
2273 * @param bool $bFromReplica Whether to check the replica DB instead of
2274 * the master. Hacked from false due to horrible probs on site.
2275 * @return bool True if blocked, false otherwise
2277 public function isBlocked( $bFromReplica = true ) {
2278 return $this->getBlock( $bFromReplica ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
2282 * Get the block affecting the user, or null if the user is not blocked
2284 * @param bool $bFromReplica Whether to check the replica DB instead of the master
2285 * @return Block|null
2287 public function getBlock( $bFromReplica = true ) {
2288 $this->getBlockedStatus( $bFromReplica );
2289 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
2293 * Check if user is blocked from editing a particular article
2295 * @param Title $title Title to check
2296 * @param bool $fromReplica Whether to check the replica DB instead of the master
2299 public function isBlockedFrom( $title, $fromReplica = false ) {
2300 $blocked = $this->isHidden();
2303 $block = $this->getBlock( $fromReplica );
2305 // Special handling for a user's own talk page. The block is not aware
2306 // of the user, so this must be done here.
2307 if ( $title->equals( $this->getTalkPage() ) ) {
2308 // If the block is sitewide, then whatever is set is what is honored.
2309 if ( $block->isSitewide() ) {
2310 $blocked = $block->prevents( 'editownusertalk' );
2312 // If the block is partial, ignore 'editownusertalk' unless
2313 // there is a restriction on the user talk namespace.
2314 // TODO: To be implemented with Namespace restrictions
2315 $blocked = $block->appliesToTitle( $title );
2318 $blocked = $block->appliesToTitle( $title );
2323 // only for the purpose of the hook. We really don't need this here.
2324 $allowUsertalk = $this->mAllowUsertalk
;
2326 Hooks
::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
2332 * If user is blocked, return the name of the user who placed the block
2333 * @return string Name of blocker
2335 public function blockedBy() {
2336 $this->getBlockedStatus();
2337 return $this->mBlockedby
;
2341 * If user is blocked, return the specified reason for the block
2342 * @return string Blocking reason
2344 public function blockedFor() {
2345 $this->getBlockedStatus();
2346 return $this->mBlockreason
;
2350 * If user is blocked, return the ID for the block
2351 * @return int Block ID
2353 public function getBlockId() {
2354 $this->getBlockedStatus();
2355 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
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 bool True if blocked, false otherwise
2366 public function isBlockedGlobally( $ip = '' ) {
2367 return $this->getGlobalBlock( $ip ) instanceof Block
;
2371 * Check if user is blocked on all wikis.
2372 * Do not use for actual edit permission checks!
2373 * This is intended for quick UI checks.
2375 * @param string $ip IP address, uses current client if none given
2376 * @return Block|null Block object if blocked, null otherwise
2377 * @throws FatalError
2378 * @throws MWException
2380 public function getGlobalBlock( $ip = '' ) {
2381 if ( $this->mGlobalBlock
!== null ) {
2382 return $this->mGlobalBlock ?
: null;
2384 // User is already an IP?
2385 if ( IP
::isIPAddress( $this->getName() ) ) {
2386 $ip = $this->getName();
2388 $ip = $this->getRequest()->getIP();
2390 // Avoid PHP 7.1 warning of passing $this by reference
2394 Hooks
::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
2396 if ( $blocked && $block === null ) {
2397 // back-compat: UserIsBlockedGlobally didn't have $block param first
2398 $block = new Block( [
2400 'systemBlock' => 'global-block'
2404 $this->mGlobalBlock
= $blocked ?
$block : false;
2405 return $this->mGlobalBlock ?
: null;
2409 * Check if user account is locked
2411 * @return bool True if locked, false otherwise
2413 public function isLocked() {
2414 if ( $this->mLocked
!== null ) {
2415 return $this->mLocked
;
2417 // Avoid PHP 7.1 warning of passing $this by reference
2419 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$user ], null );
2420 $this->mLocked
= $authUser && $authUser->isLocked();
2421 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2422 return $this->mLocked
;
2426 * Check if user account is hidden
2428 * @return bool True if hidden, false otherwise
2430 public function isHidden() {
2431 if ( $this->mHideName
!== null ) {
2432 return (bool)$this->mHideName
;
2434 $this->getBlockedStatus();
2435 if ( !$this->mHideName
) {
2436 // Avoid PHP 7.1 warning of passing $this by reference
2438 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$user ], null );
2439 $this->mHideName
= $authUser && $authUser->isHidden();
2440 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2442 return (bool)$this->mHideName
;
2446 * Get the user's ID.
2447 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2449 public function getId() {
2450 if ( $this->mId
=== null && $this->mName
!== null && self
::isIP( $this->mName
) ) {
2451 // Special case, we know the user is anonymous
2453 } elseif ( !$this->isItemLoaded( 'id' ) ) {
2454 // Don't load if this was initialized from an ID
2458 return (int)$this->mId
;
2462 * Set the user and reload all fields according to a given ID
2463 * @param int $v User ID to reload
2465 public function setId( $v ) {
2467 $this->clearInstanceCache( 'id' );
2471 * Get the user name, or the IP of an anonymous user
2472 * @return string User's name or IP address
2474 public function getName() {
2475 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2476 // Special case optimisation
2477 return $this->mName
;
2480 if ( $this->mName
=== false ) {
2482 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2484 return $this->mName
;
2489 * Set the user name.
2491 * This does not reload fields from the database according to the given
2492 * name. Rather, it is used to create a temporary "nonexistent user" for
2493 * later addition to the database. It can also be used to set the IP
2494 * address for an anonymous user to something other than the current
2497 * @note User::newFromName() has roughly the same function, when the named user
2499 * @param string $str New user name to set
2501 public function setName( $str ) {
2503 $this->mName
= $str;
2507 * Get the user's actor ID.
2509 * @param IDatabase|null $dbw Assign a new actor ID, using this DB handle, if none exists
2510 * @return int The actor's ID, or 0 if no actor ID exists and $dbw was null
2512 public function getActorId( IDatabase
$dbw = null ) {
2513 global $wgActorTableSchemaMigrationStage;
2515 // Technically we should always return 0 without SCHEMA_COMPAT_READ_NEW,
2516 // but it does little harm and might be needed for write callers loading a User.
2517 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) ) {
2521 if ( !$this->isItemLoaded( 'actor' ) ) {
2525 // Currently $this->mActorId might be null if $this was loaded from a
2526 // cache entry that was written when $wgActorTableSchemaMigrationStage
2527 // was SCHEMA_COMPAT_OLD. Once that is no longer a possibility (i.e. when
2528 // User::VERSION is incremented after $wgActorTableSchemaMigrationStage
2529 // has been removed), that condition may be removed.
2530 if ( $this->mActorId
=== null ||
!$this->mActorId
&& $dbw ) {
2532 'actor_user' => $this->getId() ?
: null,
2533 'actor_name' => (string)$this->getName(),
2536 if ( $q['actor_user'] === null && self
::isUsableName( $q['actor_name'] ) ) {
2537 throw new CannotCreateActorException(
2538 'Cannot create an actor for a usable name that is not an existing user'
2541 if ( $q['actor_name'] === '' ) {
2542 throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
2544 $dbw->insert( 'actor', $q, __METHOD__
, [ 'IGNORE' ] );
2545 if ( $dbw->affectedRows() ) {
2546 $this->mActorId
= (int)$dbw->insertId();
2549 // Use LOCK IN SHARE MODE to bypass any MySQL REPEATABLE-READ snapshot.
2550 $this->mActorId
= (int)$dbw->selectField(
2555 [ 'LOCK IN SHARE MODE' ]
2557 if ( !$this->mActorId
) {
2558 throw new CannotCreateActorException(
2559 "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
2563 $this->invalidateCache();
2565 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2566 $db = wfGetDB( $index );
2567 $this->mActorId
= (int)$db->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2569 $this->setItemLoaded( 'actor' );
2572 return (int)$this->mActorId
;
2576 * Get the user's name escaped by underscores.
2577 * @return string Username escaped by underscores.
2579 public function getTitleKey() {
2580 return str_replace( ' ', '_', $this->getName() );
2584 * Check if the user has new messages.
2585 * @return bool True if the user has new messages
2587 public function getNewtalk() {
2590 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2591 if ( $this->mNewtalk
=== -1 ) {
2592 $this->mNewtalk
= false; # reset talk page status
2594 // Check memcached separately for anons, who have no
2595 // entire User object stored in there.
2596 if ( !$this->mId
) {
2597 global $wgDisableAnonTalk;
2598 if ( $wgDisableAnonTalk ) {
2599 // Anon newtalk disabled by configuration.
2600 $this->mNewtalk
= false;
2602 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2605 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2609 return (bool)$this->mNewtalk
;
2613 * Return the data needed to construct links for new talk page message
2614 * alerts. If there are new messages, this will return an associative array
2615 * with the following data:
2616 * wiki: The database name of the wiki
2617 * link: Root-relative link to the user's talk page
2618 * rev: The last talk page revision that the user has seen or null. This
2619 * is useful for building diff links.
2620 * If there are no new messages, it returns an empty array.
2621 * @note This function was designed to accomodate multiple talk pages, but
2622 * currently only returns a single link and revision.
2625 public function getNewMessageLinks() {
2626 // Avoid PHP 7.1 warning of passing $this by reference
2629 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
2631 } elseif ( !$this->getNewtalk() ) {
2634 $utp = $this->getTalkPage();
2635 $dbr = wfGetDB( DB_REPLICA
);
2636 // Get the "last viewed rev" timestamp from the oldest message notification
2637 $timestamp = $dbr->selectField( 'user_newtalk',
2638 'MIN(user_last_timestamp)',
2639 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2641 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2644 'wiki' => WikiMap
::getWikiIdFromDomain( WikiMap
::getCurrentWikiDomain() ),
2645 'link' => $utp->getLocalURL(),
2652 * Get the revision ID for the last talk page revision viewed by the talk
2654 * @return int|null Revision ID or null
2656 public function getNewMessageRevisionId() {
2657 $newMessageRevisionId = null;
2658 $newMessageLinks = $this->getNewMessageLinks();
2659 if ( $newMessageLinks ) {
2660 // Note: getNewMessageLinks() never returns more than a single link
2661 // and it is always for the same wiki, but we double-check here in
2662 // case that changes some time in the future.
2663 if ( count( $newMessageLinks ) === 1
2664 && WikiMap
::isCurrentWikiId( $newMessageLinks[0]['wiki'] )
2665 && $newMessageLinks[0]['rev']
2667 /** @var Revision $newMessageRevision */
2668 $newMessageRevision = $newMessageLinks[0]['rev'];
2669 $newMessageRevisionId = $newMessageRevision->getId();
2672 return $newMessageRevisionId;
2676 * Internal uncached check for new messages
2679 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2680 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2681 * @return bool True if the user has new messages
2683 protected function checkNewtalk( $field, $id ) {
2684 $dbr = wfGetDB( DB_REPLICA
);
2686 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2688 return $ok !== false;
2692 * Add or update the new messages flag
2693 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2694 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2695 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2696 * @return bool True if successful, false otherwise
2698 protected function updateNewtalk( $field, $id, $curRev = null ) {
2699 // Get timestamp of the talk page revision prior to the current one
2700 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2701 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2702 // Mark the user as having new messages since this revision
2703 $dbw = wfGetDB( DB_MASTER
);
2704 $dbw->insert( 'user_newtalk',
2705 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2708 if ( $dbw->affectedRows() ) {
2709 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2712 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2718 * Clear the new messages flag for the given user
2719 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2720 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2721 * @return bool True if successful, false otherwise
2723 protected function deleteNewtalk( $field, $id ) {
2724 $dbw = wfGetDB( DB_MASTER
);
2725 $dbw->delete( 'user_newtalk',
2728 if ( $dbw->affectedRows() ) {
2729 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2732 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2738 * Update the 'You have new messages!' status.
2739 * @param bool $val Whether the user has new messages
2740 * @param Revision|null $curRev New, as yet unseen revision of the user talk
2741 * page. Ignored if null or !$val.
2743 public function setNewtalk( $val, $curRev = null ) {
2744 if ( wfReadOnly() ) {
2749 $this->mNewtalk
= $val;
2751 if ( $this->isAnon() ) {
2753 $id = $this->getName();
2756 $id = $this->getId();
2760 $changed = $this->updateNewtalk( $field, $id, $curRev );
2762 $changed = $this->deleteNewtalk( $field, $id );
2766 $this->invalidateCache();
2771 * Generate a current or new-future timestamp to be stored in the
2772 * user_touched field when we update things.
2773 * @return string Timestamp in TS_MW format
2775 private function newTouchedTimestamp() {
2776 global $wgClockSkewFudge;
2778 $time = wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2779 if ( $this->mTouched
&& $time <= $this->mTouched
) {
2780 $time = wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2787 * Clear user data from memcached
2789 * Use after applying updates to the database; caller's
2790 * responsibility to update user_touched if appropriate.
2792 * Called implicitly from invalidateCache() and saveSettings().
2794 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2796 public function clearSharedCache( $mode = 'changed' ) {
2797 if ( !$this->getId() ) {
2801 $cache = ObjectCache
::getMainWANInstance();
2802 $key = $this->getCacheKey( $cache );
2803 if ( $mode === 'refresh' ) {
2804 $cache->delete( $key, 1 );
2806 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2807 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2808 $lb->getConnection( DB_MASTER
)->onTransactionPreCommitOrIdle(
2809 function () use ( $cache, $key ) {
2810 $cache->delete( $key );
2815 $cache->delete( $key );
2821 * Immediately touch the user data cache for this account
2823 * Calls touch() and removes account data from memcached
2825 public function invalidateCache() {
2827 $this->clearSharedCache();
2831 * Update the "touched" timestamp for the user
2833 * This is useful on various login/logout events when making sure that
2834 * a browser or proxy that has multiple tenants does not suffer cache
2835 * pollution where the new user sees the old users content. The value
2836 * of getTouched() is checked when determining 304 vs 200 responses.
2837 * Unlike invalidateCache(), this preserves the User object cache and
2838 * avoids database writes.
2842 public function touch() {
2843 $id = $this->getId();
2845 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2846 $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
2847 $cache->touchCheckKey( $key );
2848 $this->mQuickTouched
= null;
2853 * Validate the cache for this account.
2854 * @param string $timestamp A timestamp in TS_MW format
2857 public function validateCache( $timestamp ) {
2858 return ( $timestamp >= $this->getTouched() );
2862 * Get the user touched timestamp
2864 * Use this value only to validate caches via inequalities
2865 * such as in the case of HTTP If-Modified-Since response logic
2867 * @return string TS_MW Timestamp
2869 public function getTouched() {
2873 if ( $this->mQuickTouched
=== null ) {
2874 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2875 $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId
);
2877 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2880 return max( $this->mTouched
, $this->mQuickTouched
);
2883 return $this->mTouched
;
2887 * Get the user_touched timestamp field (time of last DB updates)
2888 * @return string TS_MW Timestamp
2891 public function getDBTouched() {
2894 return $this->mTouched
;
2898 * Set the password and reset the random token.
2899 * Calls through to authentication plugin if necessary;
2900 * will have no effect if the auth plugin refuses to
2901 * pass the change through or if the legal password
2904 * As a special case, setting the password to null
2905 * wipes it, so the account cannot be logged in until
2906 * a new password is set, for instance via e-mail.
2908 * @deprecated since 1.27, use AuthManager instead
2909 * @param string $str New password to set
2910 * @throws PasswordError On failure
2913 public function setPassword( $str ) {
2914 wfDeprecated( __METHOD__
, '1.27' );
2915 return $this->setPasswordInternal( $str );
2919 * Set the password and reset the random token unconditionally.
2921 * @deprecated since 1.27, use AuthManager instead
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.
2926 public function setInternalPassword( $str ) {
2927 wfDeprecated( __METHOD__
, '1.27' );
2928 $this->setPasswordInternal( $str );
2932 * Actually set the password and such
2933 * @since 1.27 cannot set a password for a user not in the database
2934 * @param string|null $str New password to set or null to set an invalid
2935 * password hash meaning that the user will not be able to log in
2936 * through the web interface.
2937 * @return bool Success
2939 private function setPasswordInternal( $str ) {
2940 $manager = AuthManager
::singleton();
2942 // If the user doesn't exist yet, fail
2943 if ( !$manager->userExists( $this->getName() ) ) {
2944 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2947 $status = $this->changeAuthenticationData( [
2948 'username' => $this->getName(),
2952 if ( !$status->isGood() ) {
2953 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2954 ->info( __METHOD__
. ': Password change rejected: '
2955 . $status->getWikiText( null, null, 'en' ) );
2959 $this->setOption( 'watchlisttoken', false );
2960 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2966 * Changes credentials of the user.
2968 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2969 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2970 * e.g. when no provider handled the change.
2972 * @param array $data A set of authentication data in fieldname => value format. This is the
2973 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2977 public function changeAuthenticationData( array $data ) {
2978 $manager = AuthManager
::singleton();
2979 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2980 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2982 $status = Status
::newGood( 'ignored' );
2983 foreach ( $reqs as $req ) {
2984 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2986 if ( $status->getValue() === 'ignored' ) {
2987 $status->warning( 'authenticationdatachange-ignored' );
2990 if ( $status->isGood() ) {
2991 foreach ( $reqs as $req ) {
2992 $manager->changeAuthenticationData( $req );
2999 * Get the user's current token.
3000 * @param bool $forceCreation Force the generation of a new token if the
3001 * user doesn't have one (default=true for backwards compatibility).
3002 * @return string|null Token
3004 public function getToken( $forceCreation = true ) {
3005 global $wgAuthenticationTokenVersion;
3008 if ( !$this->mToken
&& $forceCreation ) {
3012 if ( !$this->mToken
) {
3013 // The user doesn't have a token, return null to indicate that.
3015 } elseif ( $this->mToken
=== self
::INVALID_TOKEN
) {
3016 // We return a random value here so existing token checks are very
3018 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3019 } elseif ( $wgAuthenticationTokenVersion === null ) {
3020 // $wgAuthenticationTokenVersion not in use, so return the raw secret
3021 return $this->mToken
;
3023 // $wgAuthenticationTokenVersion in use, so hmac it.
3024 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
3026 // The raw hash can be overly long. Shorten it up.
3027 $len = max( 32, self
::TOKEN_LENGTH
);
3028 if ( strlen( $ret ) < $len ) {
3029 // Should never happen, even md5 is 128 bits
3030 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
3032 return substr( $ret, -$len );
3037 * Set the random token (used for persistent authentication)
3038 * Called from loadDefaults() among other places.
3040 * @param string|bool $token If specified, set the token to this value
3042 public function setToken( $token = false ) {
3044 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
3045 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3046 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
3047 } elseif ( !$token ) {
3048 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3050 $this->mToken
= $token;
3055 * Set the password for a password reminder or new account email
3057 * @deprecated Removed in 1.27. Use PasswordReset instead.
3058 * @param string $str New password to set or null to set an invalid
3059 * password hash meaning that the user will not be able to use it
3060 * @param bool $throttle If true, reset the throttle timestamp to the present
3062 public function setNewpassword( $str, $throttle = true ) {
3063 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
3067 * Get the user's e-mail address
3068 * @return string User's email address
3070 public function getEmail() {
3072 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
3073 return $this->mEmail
;
3077 * Get the timestamp of the user's e-mail authentication
3078 * @return string TS_MW timestamp
3080 public function getEmailAuthenticationTimestamp() {
3082 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
3083 return $this->mEmailAuthenticated
;
3087 * Set the user's e-mail address
3088 * @param string $str New e-mail address
3090 public function setEmail( $str ) {
3092 if ( $str == $this->mEmail
) {
3095 $this->invalidateEmail();
3096 $this->mEmail
= $str;
3097 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
3101 * Set the user's e-mail address and a confirmation mail if needed.
3104 * @param string $str New e-mail address
3107 public function setEmailWithConfirmation( $str ) {
3108 global $wgEnableEmail, $wgEmailAuthentication;
3110 if ( !$wgEnableEmail ) {
3111 return Status
::newFatal( 'emaildisabled' );
3114 $oldaddr = $this->getEmail();
3115 if ( $str === $oldaddr ) {
3116 return Status
::newGood( true );
3119 $type = $oldaddr != '' ?
'changed' : 'set';
3120 $notificationResult = null;
3122 if ( $wgEmailAuthentication ) {
3123 // Send the user an email notifying the user of the change in registered
3124 // email address on their previous email address
3125 if ( $type == 'changed' ) {
3126 $change = $str != '' ?
'changed' : 'removed';
3127 $notificationResult = $this->sendMail(
3128 wfMessage( 'notificationemail_subject_' . $change )->text(),
3129 wfMessage( 'notificationemail_body_' . $change,
3130 $this->getRequest()->getIP(),
3137 $this->setEmail( $str );
3139 if ( $str !== '' && $wgEmailAuthentication ) {
3140 // Send a confirmation request to the new address if needed
3141 $result = $this->sendConfirmationMail( $type );
3143 if ( $notificationResult !== null ) {
3144 $result->merge( $notificationResult );
3147 if ( $result->isGood() ) {
3148 // Say to the caller that a confirmation and notification mail has been sent
3149 $result->value
= 'eauth';
3152 $result = Status
::newGood( true );
3159 * Get the user's real name
3160 * @return string User's real name
3162 public function getRealName() {
3163 if ( !$this->isItemLoaded( 'realname' ) ) {
3167 return $this->mRealName
;
3171 * Set the user's real name
3172 * @param string $str New real name
3174 public function setRealName( $str ) {
3176 $this->mRealName
= $str;
3180 * Get the user's current setting for a given option.
3182 * @param string $oname The option to check
3183 * @param string|array|null $defaultOverride A default value returned if the option does not exist
3184 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
3185 * @return string|array|int|null User's current value for the option
3186 * @see getBoolOption()
3187 * @see getIntOption()
3189 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
3190 global $wgHiddenPrefs;
3191 $this->loadOptions();
3193 # We want 'disabled' preferences to always behave as the default value for
3194 # users, even if they have set the option explicitly in their settings (ie they
3195 # set it, and then it was disabled removing their ability to change it). But
3196 # we don't want to erase the preferences in the database in case the preference
3197 # is re-enabled again. So don't touch $mOptions, just override the returned value
3198 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
3199 return self
::getDefaultOption( $oname );
3202 if ( array_key_exists( $oname, $this->mOptions
) ) {
3203 return $this->mOptions
[$oname];
3205 return $defaultOverride;
3210 * Get all user's options
3212 * @param int $flags Bitwise combination of:
3213 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
3214 * to the default value. (Since 1.25)
3217 public function getOptions( $flags = 0 ) {
3218 global $wgHiddenPrefs;
3219 $this->loadOptions();
3220 $options = $this->mOptions
;
3222 # We want 'disabled' preferences to always behave as the default value for
3223 # users, even if they have set the option explicitly in their settings (ie they
3224 # set it, and then it was disabled removing their ability to change it). But
3225 # we don't want to erase the preferences in the database in case the preference
3226 # is re-enabled again. So don't touch $mOptions, just override the returned value
3227 foreach ( $wgHiddenPrefs as $pref ) {
3228 $default = self
::getDefaultOption( $pref );
3229 if ( $default !== null ) {
3230 $options[$pref] = $default;
3234 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
3235 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
3242 * Get the user's current setting for a given option, as a boolean value.
3244 * @param string $oname The option to check
3245 * @return bool User's current value for the option
3248 public function getBoolOption( $oname ) {
3249 return (bool)$this->getOption( $oname );
3253 * Get the user's current setting for a given option, as an integer value.
3255 * @param string $oname The option to check
3256 * @param int $defaultOverride A default value returned if the option does not exist
3257 * @return int User's current value for the option
3260 public function getIntOption( $oname, $defaultOverride = 0 ) {
3261 $val = $this->getOption( $oname );
3263 $val = $defaultOverride;
3265 return intval( $val );
3269 * Set the given option for a user.
3271 * You need to call saveSettings() to actually write to the database.
3273 * @param string $oname The option to set
3274 * @param mixed $val New value to set
3276 public function setOption( $oname, $val ) {
3277 $this->loadOptions();
3279 // Explicitly NULL values should refer to defaults
3280 if ( is_null( $val ) ) {
3281 $val = self
::getDefaultOption( $oname );
3284 $this->mOptions
[$oname] = $val;
3288 * Get a token stored in the preferences (like the watchlist one),
3289 * resetting it if it's empty (and saving changes).
3291 * @param string $oname The option name to retrieve the token from
3292 * @return string|bool User's current value for the option, or false if this option is disabled.
3293 * @see resetTokenFromOption()
3295 * @deprecated since 1.26 Applications should use the OAuth extension
3297 public function getTokenFromOption( $oname ) {
3298 global $wgHiddenPrefs;
3300 $id = $this->getId();
3301 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
3305 $token = $this->getOption( $oname );
3307 // Default to a value based on the user token to avoid space
3308 // wasted on storing tokens for all users. When this option
3309 // is set manually by the user, only then is it stored.
3310 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
3317 * Reset a token stored in the preferences (like the watchlist one).
3318 * *Does not* save user's preferences (similarly to setOption()).
3320 * @param string $oname The option name to reset the token in
3321 * @return string|bool New token value, or false if this option is disabled.
3322 * @see getTokenFromOption()
3325 public function resetTokenFromOption( $oname ) {
3326 global $wgHiddenPrefs;
3327 if ( in_array( $oname, $wgHiddenPrefs ) ) {
3331 $token = MWCryptRand
::generateHex( 40 );
3332 $this->setOption( $oname, $token );
3337 * Return a list of the types of user options currently returned by
3338 * User::getOptionKinds().
3340 * Currently, the option kinds are:
3341 * - 'registered' - preferences which are registered in core MediaWiki or
3342 * by extensions using the UserGetDefaultOptions hook.
3343 * - 'registered-multiselect' - as above, using the 'multiselect' type.
3344 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
3345 * - 'userjs' - preferences with names starting with 'userjs-', intended to
3346 * be used by user scripts.
3347 * - 'special' - "preferences" that are not accessible via User::getOptions
3348 * or User::setOptions.
3349 * - 'unused' - preferences about which MediaWiki doesn't know anything.
3350 * These are usually legacy options, removed in newer versions.
3352 * The API (and possibly others) use this function to determine the possible
3353 * option types for validation purposes, so make sure to update this when a
3354 * new option kind is added.
3356 * @see User::getOptionKinds
3357 * @return array Option kinds
3359 public static function listOptionKinds() {
3362 'registered-multiselect',
3363 'registered-checkmatrix',
3371 * Return an associative array mapping preferences keys to the kind of a preference they're
3372 * used for. Different kinds are handled differently when setting or reading preferences.
3374 * See User::listOptionKinds for the list of valid option types that can be provided.
3376 * @see User::listOptionKinds
3377 * @param IContextSource $context
3378 * @param array|null $options Assoc. array with options keys to check as keys.
3379 * Defaults to $this->mOptions.
3380 * @return array The key => kind mapping data
3382 public function getOptionKinds( IContextSource
$context, $options = null ) {
3383 $this->loadOptions();
3384 if ( $options === null ) {
3385 $options = $this->mOptions
;
3388 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
3389 $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
3392 // Pull out the "special" options, so they don't get converted as
3393 // multiselect or checkmatrix.
3394 $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
3395 foreach ( $specialOptions as $name => $value ) {
3396 unset( $prefs[$name] );
3399 // Multiselect and checkmatrix options are stored in the database with
3400 // one key per option, each having a boolean value. Extract those keys.
3401 $multiselectOptions = [];
3402 foreach ( $prefs as $name => $info ) {
3403 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3404 ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField
::class ) ) {
3405 $opts = HTMLFormField
::flattenOptions( $info['options'] );
3406 $prefix = $info['prefix'] ??
$name;
3408 foreach ( $opts as $value ) {
3409 $multiselectOptions["$prefix$value"] = true;
3412 unset( $prefs[$name] );
3415 $checkmatrixOptions = [];
3416 foreach ( $prefs as $name => $info ) {
3417 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3418 ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix
::class ) ) {
3419 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3420 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3421 $prefix = $info['prefix'] ??
$name;
3423 foreach ( $columns as $column ) {
3424 foreach ( $rows as $row ) {
3425 $checkmatrixOptions["$prefix$column-$row"] = true;
3429 unset( $prefs[$name] );
3433 // $value is ignored
3434 foreach ( $options as $key => $value ) {
3435 if ( isset( $prefs[$key] ) ) {
3436 $mapping[$key] = 'registered';
3437 } elseif ( isset( $multiselectOptions[$key] ) ) {
3438 $mapping[$key] = 'registered-multiselect';
3439 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3440 $mapping[$key] = 'registered-checkmatrix';
3441 } elseif ( isset( $specialOptions[$key] ) ) {
3442 $mapping[$key] = 'special';
3443 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3444 $mapping[$key] = 'userjs';
3446 $mapping[$key] = 'unused';
3454 * Reset certain (or all) options to the site defaults
3456 * The optional parameter determines which kinds of preferences will be reset.
3457 * Supported values are everything that can be reported by getOptionKinds()
3458 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3460 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3461 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3462 * for backwards-compatibility.
3463 * @param IContextSource|null $context Context source used when $resetKinds
3464 * does not contain 'all', passed to getOptionKinds().
3465 * Defaults to RequestContext::getMain() when null.
3467 public function resetOptions(
3468 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3469 IContextSource
$context = null
3472 $defaultOptions = self
::getDefaultOptions();
3474 if ( !is_array( $resetKinds ) ) {
3475 $resetKinds = [ $resetKinds ];
3478 if ( in_array( 'all', $resetKinds ) ) {
3479 $newOptions = $defaultOptions;
3481 if ( $context === null ) {
3482 $context = RequestContext
::getMain();
3485 $optionKinds = $this->getOptionKinds( $context );
3486 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3489 // Use default values for the options that should be deleted, and
3490 // copy old values for the ones that shouldn't.
3491 foreach ( $this->mOptions
as $key => $value ) {
3492 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3493 if ( array_key_exists( $key, $defaultOptions ) ) {
3494 $newOptions[$key] = $defaultOptions[$key];
3497 $newOptions[$key] = $value;
3502 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3504 $this->mOptions
= $newOptions;
3505 $this->mOptionsLoaded
= true;
3509 * Get the user's preferred date format.
3510 * @return string User's preferred date format
3512 public function getDatePreference() {
3513 // Important migration for old data rows
3514 if ( is_null( $this->mDatePreference
) ) {
3516 $value = $this->getOption( 'date' );
3517 $map = $wgLang->getDatePreferenceMigrationMap();
3518 if ( isset( $map[$value] ) ) {
3519 $value = $map[$value];
3521 $this->mDatePreference
= $value;
3523 return $this->mDatePreference
;
3527 * Determine based on the wiki configuration and the user's options,
3528 * whether this user must be over HTTPS no matter what.
3532 public function requiresHTTPS() {
3533 global $wgSecureLogin;
3534 if ( !$wgSecureLogin ) {
3537 $https = $this->getBoolOption( 'prefershttps' );
3538 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3540 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3547 * Get the user preferred stub threshold
3551 public function getStubThreshold() {
3552 global $wgMaxArticleSize; # Maximum article size, in Kb
3553 $threshold = $this->getIntOption( 'stubthreshold' );
3554 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3555 // If they have set an impossible value, disable the preference
3556 // so we can use the parser cache again.
3563 * Get the permissions this user has.
3564 * @return string[] permission names
3566 public function getRights() {
3567 if ( is_null( $this->mRights
) ) {
3568 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3569 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3571 // Deny any rights denied by the user's session, unless this
3572 // endpoint has no sessions.
3573 if ( !defined( 'MW_NO_SESSION' ) ) {
3574 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3575 if ( $allowedRights !== null ) {
3576 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3580 Hooks
::run( 'UserGetRightsRemove', [ $this, &$this->mRights
] );
3581 // Force reindexation of rights when a hook has unset one of them
3582 $this->mRights
= array_values( array_unique( $this->mRights
) );
3584 // If block disables login, we should also remove any
3585 // extra rights blocked users might have, in case the
3586 // blocked user has a pre-existing session (T129738).
3587 // This is checked here for cases where people only call
3588 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3589 // to give a better error message in the common case.
3590 $config = RequestContext
::getMain()->getConfig();
3592 $this->isLoggedIn() &&
3593 $config->get( 'BlockDisablesLogin' ) &&
3597 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3600 return $this->mRights
;
3604 * Get the list of explicit group memberships this user has.
3605 * The implicit * and user groups are not included.
3607 * @return string[] Array of internal group names (sorted since 1.33)
3609 public function getGroups() {
3611 $this->loadGroups();
3612 return array_keys( $this->mGroupMemberships
);
3616 * Get the list of explicit group memberships this user has, stored as
3617 * UserGroupMembership objects. Implicit groups are not included.
3619 * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
3622 public function getGroupMemberships() {
3624 $this->loadGroups();
3625 return $this->mGroupMemberships
;
3629 * Get the list of implicit group memberships this user has.
3630 * This includes all explicit groups, plus 'user' if logged in,
3631 * '*' for all accounts, and autopromoted groups
3632 * @param bool $recache Whether to avoid the cache
3633 * @return array Array of String internal group names
3635 public function getEffectiveGroups( $recache = false ) {
3636 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3637 $this->mEffectiveGroups
= array_unique( array_merge(
3638 $this->getGroups(), // explicit groups
3639 $this->getAutomaticGroups( $recache ) // implicit groups
3641 // Avoid PHP 7.1 warning of passing $this by reference
3643 // Hook for additional groups
3644 Hooks
::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups
] );
3645 // Force reindexation of groups when a hook has unset one of them
3646 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3648 return $this->mEffectiveGroups
;
3652 * Get the list of implicit group memberships this user has.
3653 * This includes 'user' if logged in, '*' for all accounts,
3654 * and autopromoted groups
3655 * @param bool $recache Whether to avoid the cache
3656 * @return array Array of String internal group names
3658 public function getAutomaticGroups( $recache = false ) {
3659 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3660 $this->mImplicitGroups
= [ '*' ];
3661 if ( $this->getId() ) {
3662 $this->mImplicitGroups
[] = 'user';
3664 $this->mImplicitGroups
= array_unique( array_merge(
3665 $this->mImplicitGroups
,
3666 Autopromote
::getAutopromoteGroups( $this )
3670 // Assure data consistency with rights/groups,
3671 // as getEffectiveGroups() depends on this function
3672 $this->mEffectiveGroups
= null;
3675 return $this->mImplicitGroups
;
3679 * Returns the groups the user has belonged to.
3681 * The user may still belong to the returned groups. Compare with getGroups().
3683 * The function will not return groups the user had belonged to before MW 1.17
3685 * @return array Names of the groups the user has belonged to.
3687 public function getFormerGroups() {
3690 if ( is_null( $this->mFormerGroups
) ) {
3691 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3692 ?
wfGetDB( DB_MASTER
)
3693 : wfGetDB( DB_REPLICA
);
3694 $res = $db->select( 'user_former_groups',
3696 [ 'ufg_user' => $this->mId
],
3698 $this->mFormerGroups
= [];
3699 foreach ( $res as $row ) {
3700 $this->mFormerGroups
[] = $row->ufg_group
;
3704 return $this->mFormerGroups
;
3708 * Get the user's edit count.
3709 * @return int|null Null for anonymous users
3711 public function getEditCount() {
3712 if ( !$this->getId() ) {
3716 if ( $this->mEditCount
=== null ) {
3717 /* Populate the count, if it has not been populated yet */
3718 $dbr = wfGetDB( DB_REPLICA
);
3719 // check if the user_editcount field has been initialized
3720 $count = $dbr->selectField(
3721 'user', 'user_editcount',
3722 [ 'user_id' => $this->mId
],
3726 if ( $count === null ) {
3727 // it has not been initialized. do so.
3728 $count = $this->initEditCountInternal();
3730 $this->mEditCount
= $count;
3732 return (int)$this->mEditCount
;
3736 * Add the user to the given group. This takes immediate effect.
3737 * If the user is already in the group, the expiry time will be updated to the new
3738 * expiry time. (If $expiry is omitted or null, the membership will be altered to
3741 * @param string $group Name of the group to add
3742 * @param string|null $expiry Optional expiry timestamp in any format acceptable to
3743 * wfTimestamp(), or null if the group assignment should not expire
3746 public function addGroup( $group, $expiry = null ) {
3748 $this->loadGroups();
3751 $expiry = wfTimestamp( TS_MW
, $expiry );
3754 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
3758 // create the new UserGroupMembership and put it in the DB
3759 $ugm = new UserGroupMembership( $this->mId
, $group, $expiry );
3760 if ( !$ugm->insert( true ) ) {
3764 $this->mGroupMemberships
[$group] = $ugm;
3766 // Refresh the groups caches, and clear the rights cache so it will be
3767 // refreshed on the next call to $this->getRights().
3768 $this->getEffectiveGroups( true );
3769 $this->mRights
= null;
3771 $this->invalidateCache();
3777 * Remove the user from the given group.
3778 * This takes immediate effect.
3779 * @param string $group Name of the group to remove
3782 public function removeGroup( $group ) {
3785 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3789 $ugm = UserGroupMembership
::getMembership( $this->mId
, $group );
3790 // delete the membership entry
3791 if ( !$ugm ||
!$ugm->delete() ) {
3795 $this->loadGroups();
3796 unset( $this->mGroupMemberships
[$group] );
3798 // Refresh the groups caches, and clear the rights cache so it will be
3799 // refreshed on the next call to $this->getRights().
3800 $this->getEffectiveGroups( true );
3801 $this->mRights
= null;
3803 $this->invalidateCache();
3809 * Get whether the user is logged in
3812 public function isLoggedIn() {
3813 return $this->getId() != 0;
3817 * Get whether the user is anonymous
3820 public function isAnon() {
3821 return !$this->isLoggedIn();
3825 * @return bool Whether this user is flagged as being a bot role account
3828 public function isBot() {
3829 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3834 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3840 * Check if user is allowed to access a feature / make an action
3842 * @param string $permissions,... Permissions to test
3843 * @return bool True if user is allowed to perform *any* of the given actions
3845 public function isAllowedAny() {
3846 $permissions = func_get_args();
3847 foreach ( $permissions as $permission ) {
3848 if ( $this->isAllowed( $permission ) ) {
3857 * @param string $permissions,... Permissions to test
3858 * @return bool True if the user is allowed to perform *all* of the given actions
3860 public function isAllowedAll() {
3861 $permissions = func_get_args();
3862 foreach ( $permissions as $permission ) {
3863 if ( !$this->isAllowed( $permission ) ) {
3871 * Internal mechanics of testing a permission
3872 * @param string $action
3875 public function isAllowed( $action = '' ) {
3876 if ( $action === '' ) {
3877 return true; // In the spirit of DWIM
3879 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3880 // by misconfiguration: 0 == 'foo'
3881 return in_array( $action, $this->getRights(), true );
3885 * Check whether to enable recent changes patrol features for this user
3886 * @return bool True or false
3888 public function useRCPatrol() {
3889 global $wgUseRCPatrol;
3890 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3894 * Check whether to enable new pages patrol features for this user
3895 * @return bool True or false
3897 public function useNPPatrol() {
3898 global $wgUseRCPatrol, $wgUseNPPatrol;
3900 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3901 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3906 * Check whether to enable new files patrol features for this user
3907 * @return bool True or false
3909 public function useFilePatrol() {
3910 global $wgUseRCPatrol, $wgUseFilePatrol;
3912 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3913 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3918 * Get the WebRequest object to use with this object
3920 * @return WebRequest
3922 public function getRequest() {
3923 if ( $this->mRequest
) {
3924 return $this->mRequest
;
3932 * Check the watched status of an article.
3933 * @since 1.22 $checkRights parameter added
3934 * @param Title $title Title of the article to look at
3935 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3936 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3939 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3940 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3941 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3948 * @since 1.22 $checkRights parameter added
3949 * @param Title $title Title of the article to look at
3950 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3951 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3953 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3954 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3955 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3957 [ $title->getSubjectPage(), $title->getTalkPage() ]
3960 $this->invalidateCache();
3964 * Stop watching an article.
3965 * @since 1.22 $checkRights parameter added
3966 * @param Title $title Title of the article to look at
3967 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3968 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3970 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3971 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3972 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3973 $store->removeWatch( $this, $title->getSubjectPage() );
3974 $store->removeWatch( $this, $title->getTalkPage() );
3976 $this->invalidateCache();
3980 * Clear the user's notification timestamp for the given title.
3981 * If e-notif e-mails are on, they will receive notification mails on
3982 * the next change of the page if it's watched etc.
3983 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3984 * @param Title &$title Title of the article to look at
3985 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3987 public function clearNotification( &$title, $oldid = 0 ) {
3988 global $wgUseEnotif, $wgShowUpdatedMarker;
3990 // Do nothing if the database is locked to writes
3991 if ( wfReadOnly() ) {
3995 // Do nothing if not allowed to edit the watchlist
3996 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
4000 // If we're working on user's talk page, we should update the talk page message indicator
4001 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
4002 // Avoid PHP 7.1 warning of passing $this by reference
4004 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
4008 // Try to update the DB post-send and only if needed...
4009 DeferredUpdates
::addCallableUpdate( function () use ( $title, $oldid ) {
4010 if ( !$this->getNewtalk() ) {
4011 return; // no notifications to clear
4014 // Delete the last notifications (they stack up)
4015 $this->setNewtalk( false );
4017 // If there is a new, unseen, revision, use its timestamp
4019 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
4022 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
4027 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4031 if ( $this->isAnon() ) {
4032 // Nothing else to do...
4036 // Only update the timestamp if the page is being watched.
4037 // The query to find out if it is watched is cached both in memcached and per-invocation,
4038 // and when it does have to be executed, it can be on a replica DB
4039 // If this is the user's newtalk page, we always update the timestamp
4041 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
4045 MediaWikiServices
::getInstance()->getWatchedItemStore()
4046 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
4050 * Resets all of the given user's page-change notification timestamps.
4051 * If e-notif e-mails are on, they will receive notification mails on
4052 * the next change of any watched page.
4053 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
4055 public function clearAllNotifications() {
4056 global $wgUseEnotif, $wgShowUpdatedMarker;
4057 // Do nothing if not allowed to edit the watchlist
4058 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
4062 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4063 $this->setNewtalk( false );
4067 $id = $this->getId();
4072 $watchedItemStore = MediaWikiServices
::getInstance()->getWatchedItemStore();
4073 $watchedItemStore->resetAllNotificationTimestampsForUser( $this );
4075 // We also need to clear here the "you have new message" notification for the own
4076 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
4080 * Compute experienced level based on edit count and registration date.
4082 * @return string 'newcomer', 'learner', or 'experienced'
4084 public function getExperienceLevel() {
4085 global $wgLearnerEdits,
4086 $wgExperiencedUserEdits,
4087 $wgLearnerMemberSince,
4088 $wgExperiencedUserMemberSince;
4090 if ( $this->isAnon() ) {
4094 $editCount = $this->getEditCount();
4095 $registration = $this->getRegistration();
4097 $learnerRegistration = wfTimestamp( TS_MW
, $now - $wgLearnerMemberSince * 86400 );
4098 $experiencedRegistration = wfTimestamp( TS_MW
, $now - $wgExperiencedUserMemberSince * 86400 );
4101 $editCount < $wgLearnerEdits ||
4102 $registration > $learnerRegistration
4106 $editCount > $wgExperiencedUserEdits &&
4107 $registration <= $experiencedRegistration
4109 return 'experienced';
4116 * Persist this user's session (e.g. set cookies)
4118 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
4120 * @param bool|null $secure Whether to force secure/insecure cookies or use default
4121 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
4123 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
4125 if ( $this->mId
== 0 ) {
4129 $session = $this->getRequest()->getSession();
4130 if ( $request && $session->getRequest() !== $request ) {
4131 $session = $session->sessionWithRequest( $request );
4133 $delay = $session->delaySave();
4135 if ( !$session->getUser()->equals( $this ) ) {
4136 if ( !$session->canSetUser() ) {
4137 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4138 ->warning( __METHOD__
.
4139 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
4143 $session->setUser( $this );
4146 $session->setRememberUser( $rememberMe );
4147 if ( $secure !== null ) {
4148 $session->setForceHTTPS( $secure );
4151 $session->persist();
4153 ScopedCallback
::consume( $delay );
4157 * Log this user out.
4159 public function logout() {
4160 // Avoid PHP 7.1 warning of passing $this by reference
4162 if ( Hooks
::run( 'UserLogout', [ &$user ] ) ) {
4168 * Clear the user's session, and reset the instance cache.
4171 public function doLogout() {
4172 $session = $this->getRequest()->getSession();
4173 if ( !$session->canSetUser() ) {
4174 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4175 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
4176 $error = 'immutable';
4177 } elseif ( !$session->getUser()->equals( $this ) ) {
4178 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4179 ->warning( __METHOD__
.
4180 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
4182 // But we still may as well make this user object anon
4183 $this->clearInstanceCache( 'defaults' );
4184 $error = 'wronguser';
4186 $this->clearInstanceCache( 'defaults' );
4187 $delay = $session->delaySave();
4188 $session->unpersist(); // Clear cookies (T127436)
4189 $session->setLoggedOutTimestamp( time() );
4190 $session->setUser( new User
);
4191 $session->set( 'wsUserID', 0 ); // Other code expects this
4192 $session->resetAllTokens();
4193 ScopedCallback
::consume( $delay );
4196 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
4197 'event' => 'logout',
4198 'successful' => $error === false,
4199 'status' => $error ?
: 'success',
4204 * Save this user's settings into the database.
4205 * @todo Only rarely do all these fields need to be set!
4207 public function saveSettings() {
4208 if ( wfReadOnly() ) {
4209 // @TODO: caller should deal with this instead!
4210 // This should really just be an exception.
4211 MWExceptionHandler
::logException( new DBExpectedError(
4213 "Could not update user with ID '{$this->mId}'; DB is read-only."
4219 if ( $this->mId
== 0 ) {
4223 // Get a new user_touched that is higher than the old one.
4224 // This will be used for a CAS check as a last-resort safety
4225 // check against race conditions and replica DB lag.
4226 $newTouched = $this->newTouchedTimestamp();
4228 $dbw = wfGetDB( DB_MASTER
);
4229 $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $newTouched ) {
4230 global $wgActorTableSchemaMigrationStage;
4232 $dbw->update( 'user',
4234 'user_name' => $this->mName
,
4235 'user_real_name' => $this->mRealName
,
4236 'user_email' => $this->mEmail
,
4237 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4238 'user_touched' => $dbw->timestamp( $newTouched ),
4239 'user_token' => strval( $this->mToken
),
4240 'user_email_token' => $this->mEmailToken
,
4241 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
4242 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
4243 'user_id' => $this->mId
,
4247 if ( !$dbw->affectedRows() ) {
4248 // Maybe the problem was a missed cache update; clear it to be safe
4249 $this->clearSharedCache( 'refresh' );
4250 // User was changed in the meantime or loaded with stale data
4251 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
4252 LoggerFactory
::getInstance( 'preferences' )->warning(
4253 "CAS update failed on user_touched for user ID '{user_id}' ({db_flag} read)",
4254 [ 'user_id' => $this->mId
, 'db_flag' => $from ]
4256 throw new MWException( "CAS update failed on user_touched. " .
4257 "The version of the user to be saved is older than the current version."
4261 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4264 [ 'actor_name' => $this->mName
],
4265 [ 'actor_user' => $this->mId
],
4271 $this->mTouched
= $newTouched;
4272 $this->saveOptions();
4274 Hooks
::run( 'UserSaveSettings', [ $this ] );
4275 $this->clearSharedCache();
4276 $this->getUserPage()->invalidateCache();
4280 * If only this user's username is known, and it exists, return the user ID.
4282 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
4285 public function idForName( $flags = 0 ) {
4286 $s = trim( $this->getName() );
4291 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
4292 ?
wfGetDB( DB_MASTER
)
4293 : wfGetDB( DB_REPLICA
);
4295 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
4296 ?
[ 'LOCK IN SHARE MODE' ]
4299 $id = $db->selectField( 'user',
4300 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
4306 * Add a user to the database, return the user object
4308 * @param string $name Username to add
4309 * @param array $params Array of Strings Non-default parameters to save to
4310 * the database as user_* fields:
4311 * - email: The user's email address.
4312 * - email_authenticated: The email authentication timestamp.
4313 * - real_name: The user's real name.
4314 * - options: An associative array of non-default options.
4315 * - token: Random authentication token. Do not set.
4316 * - registration: Registration timestamp. Do not set.
4318 * @return User|null User object, or null if the username already exists.
4320 public static function createNew( $name, $params = [] ) {
4321 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
4322 if ( isset( $params[$field] ) ) {
4323 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
4324 unset( $params[$field] );
4330 $user->setToken(); // init token
4331 if ( isset( $params['options'] ) ) {
4332 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
4333 unset( $params['options'] );
4335 $dbw = wfGetDB( DB_MASTER
);
4337 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4340 'user_name' => $name,
4341 'user_password' => $noPass,
4342 'user_newpassword' => $noPass,
4343 'user_email' => $user->mEmail
,
4344 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
4345 'user_real_name' => $user->mRealName
,
4346 'user_token' => strval( $user->mToken
),
4347 'user_registration' => $dbw->timestamp( $user->mRegistration
),
4348 'user_editcount' => 0,
4349 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4351 foreach ( $params as $name => $value ) {
4352 $fields["user_$name"] = $value;
4355 return $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $fields ) {
4356 $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
4357 if ( $dbw->affectedRows() ) {
4358 $newUser = self
::newFromId( $dbw->insertId() );
4359 $newUser->mName
= $fields['user_name'];
4360 $newUser->updateActorId( $dbw );
4361 // Load the user from master to avoid replica lag
4362 $newUser->load( self
::READ_LATEST
);
4371 * Add this existing user object to the database. If the user already
4372 * exists, a fatal status object is returned, and the user object is
4373 * initialised with the data from the database.
4375 * Previously, this function generated a DB error due to a key conflict
4376 * if the user already existed. Many extension callers use this function
4377 * in code along the lines of:
4379 * $user = User::newFromName( $name );
4380 * if ( !$user->isLoggedIn() ) {
4381 * $user->addToDatabase();
4383 * // do something with $user...
4385 * However, this was vulnerable to a race condition (T18020). By
4386 * initialising the user object if the user exists, we aim to support this
4387 * calling sequence as far as possible.
4389 * Note that if the user exists, this function will acquire a write lock,
4390 * so it is still advisable to make the call conditional on isLoggedIn(),
4391 * and to commit the transaction after calling.
4393 * @throws MWException
4396 public function addToDatabase() {
4398 if ( !$this->mToken
) {
4399 $this->setToken(); // init token
4402 if ( !is_string( $this->mName
) ) {
4403 throw new RuntimeException( "User name field is not set." );
4406 $this->mTouched
= $this->newTouchedTimestamp();
4408 $dbw = wfGetDB( DB_MASTER
);
4409 $status = $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) {
4410 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4411 $dbw->insert( 'user',
4413 'user_name' => $this->mName
,
4414 'user_password' => $noPass,
4415 'user_newpassword' => $noPass,
4416 'user_email' => $this->mEmail
,
4417 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4418 'user_real_name' => $this->mRealName
,
4419 'user_token' => strval( $this->mToken
),
4420 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4421 'user_editcount' => 0,
4422 'user_touched' => $dbw->timestamp( $this->mTouched
),
4426 if ( !$dbw->affectedRows() ) {
4427 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4428 $this->mId
= $dbw->selectField(
4431 [ 'user_name' => $this->mName
],
4433 [ 'LOCK IN SHARE MODE' ]
4437 if ( $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4442 throw new MWException( $fname . ": hit a key conflict attempting " .
4443 "to insert user '{$this->mName}' row, but it was not present in select!" );
4445 return Status
::newFatal( 'userexists' );
4447 $this->mId
= $dbw->insertId();
4448 self
::$idCacheByName[$this->mName
] = $this->mId
;
4449 $this->updateActorId( $dbw );
4451 return Status
::newGood();
4453 if ( !$status->isGood() ) {
4457 // Clear instance cache other than user table data and actor, which is already accurate
4458 $this->clearInstanceCache();
4460 $this->saveOptions();
4461 return Status
::newGood();
4465 * Update the actor ID after an insert
4466 * @param IDatabase $dbw Writable database handle
4468 private function updateActorId( IDatabase
$dbw ) {
4469 global $wgActorTableSchemaMigrationStage;
4471 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4474 [ 'actor_user' => $this->mId
, 'actor_name' => $this->mName
],
4477 $this->mActorId
= (int)$dbw->insertId();
4482 * If this user is logged-in and blocked,
4483 * block any IP address they've successfully logged in from.
4484 * @return bool A block was spread
4486 public function spreadAnyEditBlock() {
4487 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4488 return $this->spreadBlock();
4495 * If this (non-anonymous) user is blocked,
4496 * block the IP address they've successfully logged in from.
4497 * @return bool A block was spread
4499 protected function spreadBlock() {
4500 wfDebug( __METHOD__
. "()\n" );
4502 if ( $this->mId
== 0 ) {
4506 $userblock = Block
::newFromTarget( $this->getName() );
4507 if ( !$userblock ) {
4511 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4515 * Get whether the user is explicitly blocked from account creation.
4516 * @return bool|Block
4518 public function isBlockedFromCreateAccount() {
4519 $this->getBlockedStatus();
4520 if ( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
4521 return $this->mBlock
;
4524 # T15611: if the IP address the user is trying to create an account from is
4525 # blocked with createaccount disabled, prevent new account creation there even
4526 # when the user is logged in
4527 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4528 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4530 return $this->mBlockedFromCreateAccount
instanceof Block
4531 && $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
4532 ?
$this->mBlockedFromCreateAccount
4537 * Get whether the user is blocked from using Special:Emailuser.
4540 public function isBlockedFromEmailuser() {
4541 $this->getBlockedStatus();
4542 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
4546 * Get whether the user is blocked from using Special:Upload
4551 public function isBlockedFromUpload() {
4552 $this->getBlockedStatus();
4553 return $this->mBlock
&& $this->mBlock
->prevents( 'upload' );
4557 * Get whether the user is allowed to create an account.
4560 public function isAllowedToCreateAccount() {
4561 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4565 * Get this user's personal page title.
4567 * @return Title User's personal page title
4569 public function getUserPage() {
4570 return Title
::makeTitle( NS_USER
, $this->getName() );
4574 * Get this user's talk page title.
4576 * @return Title User's talk page title
4578 public function getTalkPage() {
4579 $title = $this->getUserPage();
4580 return $title->getTalkPage();
4584 * Determine whether the user is a newbie. Newbies are either
4585 * anonymous IPs, or the most recently created accounts.
4588 public function isNewbie() {
4589 return !$this->isAllowed( 'autoconfirmed' );
4593 * Check to see if the given clear-text password is one of the accepted passwords
4594 * @deprecated since 1.27, use AuthManager instead
4595 * @param string $password User password
4596 * @return bool True if the given password is correct, otherwise False
4598 public function checkPassword( $password ) {
4599 wfDeprecated( __METHOD__
, '1.27' );
4601 $manager = AuthManager
::singleton();
4602 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4603 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4605 'username' => $this->getName(),
4606 'password' => $password,
4609 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4610 switch ( $res->status
) {
4611 case AuthenticationResponse
::PASS
:
4613 case AuthenticationResponse
::FAIL
:
4614 // Hope it's not a PreAuthenticationProvider that failed...
4615 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4616 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4619 throw new BadMethodCallException(
4620 'AuthManager returned a response unsupported by ' . __METHOD__
4626 * Check if the given clear-text password matches the temporary password
4627 * sent by e-mail for password reset operations.
4629 * @deprecated since 1.27, use AuthManager instead
4630 * @param string $plaintext
4631 * @return bool True if matches, false otherwise
4633 public function checkTemporaryPassword( $plaintext ) {
4634 wfDeprecated( __METHOD__
, '1.27' );
4635 // Can't check the temporary password individually.
4636 return $this->checkPassword( $plaintext );
4640 * Initialize (if necessary) and return a session token value
4641 * which can be used in edit forms to show that the user's
4642 * login credentials aren't being hijacked with a foreign form
4646 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4647 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4648 * @return MediaWiki\Session\Token The new edit token
4650 public function getEditTokenObject( $salt = '', $request = null ) {
4651 if ( $this->isAnon() ) {
4652 return new LoggedOutEditToken();
4656 $request = $this->getRequest();
4658 return $request->getSession()->getToken( $salt );
4662 * Initialize (if necessary) and return a session token value
4663 * which can be used in edit forms to show that the user's
4664 * login credentials aren't being hijacked with a foreign form
4667 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4670 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4671 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4672 * @return string The new edit token
4674 public function getEditToken( $salt = '', $request = null ) {
4675 return $this->getEditTokenObject( $salt, $request )->toString();
4679 * Check given value against the token value stored in the session.
4680 * A match should confirm that the form was submitted from the
4681 * user's own login session, not a form submission from a third-party
4684 * @param string $val Input value to compare
4685 * @param string|array $salt Optional function-specific data for hashing
4686 * @param WebRequest|null $request Object to use or null to use $wgRequest
4687 * @param int|null $maxage Fail tokens older than this, in seconds
4688 * @return bool Whether the token matches
4690 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4691 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4695 * Check given value against the token value stored in the session,
4696 * ignoring the suffix.
4698 * @param string $val Input value to compare
4699 * @param string|array $salt Optional function-specific data for hashing
4700 * @param WebRequest|null $request Object to use or null to use $wgRequest
4701 * @param int|null $maxage Fail tokens older than this, in seconds
4702 * @return bool Whether the token matches
4704 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4705 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4706 return $this->matchEditToken( $val, $salt, $request, $maxage );
4710 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4711 * mail to the user's given address.
4713 * @param string $type Message to send, either "created", "changed" or "set"
4716 public function sendConfirmationMail( $type = 'created' ) {
4718 $expiration = null; // gets passed-by-ref and defined in next line.
4719 $token = $this->confirmationToken( $expiration );
4720 $url = $this->confirmationTokenUrl( $token );
4721 $invalidateURL = $this->invalidationTokenUrl( $token );
4722 $this->saveSettings();
4724 if ( $type == 'created' ||
$type === false ) {
4725 $message = 'confirmemail_body';
4726 } elseif ( $type === true ) {
4727 $message = 'confirmemail_body_changed';
4729 // Messages: confirmemail_body_changed, confirmemail_body_set
4730 $message = 'confirmemail_body_' . $type;
4733 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4734 wfMessage( $message,
4735 $this->getRequest()->getIP(),
4738 $wgLang->userTimeAndDate( $expiration, $this ),
4740 $wgLang->userDate( $expiration, $this ),
4741 $wgLang->userTime( $expiration, $this ) )->text() );
4745 * Send an e-mail to this user's account. Does not check for
4746 * confirmed status or validity.
4748 * @param string $subject Message subject
4749 * @param string $body Message body
4750 * @param User|null $from Optional sending user; if unspecified, default
4751 * $wgPasswordSender will be used.
4752 * @param string|null $replyto Reply-To address
4755 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4756 global $wgPasswordSender;
4758 if ( $from instanceof User
) {
4759 $sender = MailAddress
::newFromUser( $from );
4761 $sender = new MailAddress( $wgPasswordSender,
4762 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4764 $to = MailAddress
::newFromUser( $this );
4766 return UserMailer
::send( $to, $sender, $subject, $body, [
4767 'replyTo' => $replyto,
4772 * Generate, store, and return a new e-mail confirmation code.
4773 * A hash (unsalted, since it's used as a key) is stored.
4775 * @note Call saveSettings() after calling this function to commit
4776 * this change to the database.
4778 * @param string &$expiration Accepts the expiration time
4779 * @return string New token
4781 protected function confirmationToken( &$expiration ) {
4782 global $wgUserEmailConfirmationTokenExpiry;
4784 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4785 $expiration = wfTimestamp( TS_MW
, $expires );
4787 $token = MWCryptRand
::generateHex( 32 );
4788 $hash = md5( $token );
4789 $this->mEmailToken
= $hash;
4790 $this->mEmailTokenExpires
= $expiration;
4795 * Return a URL the user can use to confirm their email address.
4796 * @param string $token Accepts the email confirmation token
4797 * @return string New token URL
4799 protected function confirmationTokenUrl( $token ) {
4800 return $this->getTokenUrl( 'ConfirmEmail', $token );
4804 * Return a URL the user can use to invalidate their email address.
4805 * @param string $token Accepts the email confirmation token
4806 * @return string New token URL
4808 protected function invalidationTokenUrl( $token ) {
4809 return $this->getTokenUrl( 'InvalidateEmail', $token );
4813 * Internal function to format the e-mail validation/invalidation URLs.
4814 * This uses a quickie hack to use the
4815 * hardcoded English names of the Special: pages, for ASCII safety.
4817 * @note Since these URLs get dropped directly into emails, using the
4818 * short English names avoids insanely long URL-encoded links, which
4819 * also sometimes can get corrupted in some browsers/mailers
4820 * (T8957 with Gmail and Internet Explorer).
4822 * @param string $page Special page
4823 * @param string $token
4824 * @return string Formatted URL
4826 protected function getTokenUrl( $page, $token ) {
4827 // Hack to bypass localization of 'Special:'
4828 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4829 return $title->getCanonicalURL();
4833 * Mark the e-mail address confirmed.
4835 * @note Call saveSettings() after calling this function to commit the change.
4839 public function confirmEmail() {
4840 // Check if it's already confirmed, so we don't touch the database
4841 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4842 if ( !$this->isEmailConfirmed() ) {
4843 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4844 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4850 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4851 * address if it was already confirmed.
4853 * @note Call saveSettings() after calling this function to commit the change.
4854 * @return bool Returns true
4856 public function invalidateEmail() {
4858 $this->mEmailToken
= null;
4859 $this->mEmailTokenExpires
= null;
4860 $this->setEmailAuthenticationTimestamp( null );
4862 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4867 * Set the e-mail authentication timestamp.
4868 * @param string $timestamp TS_MW timestamp
4870 public function setEmailAuthenticationTimestamp( $timestamp ) {
4872 $this->mEmailAuthenticated
= $timestamp;
4873 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4877 * Is this user allowed to send e-mails within limits of current
4878 * site configuration?
4881 public function canSendEmail() {
4882 global $wgEnableEmail, $wgEnableUserEmail;
4883 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4886 $canSend = $this->isEmailConfirmed();
4887 // Avoid PHP 7.1 warning of passing $this by reference
4889 Hooks
::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
4894 * Is this user allowed to receive e-mails within limits of current
4895 * site configuration?
4898 public function canReceiveEmail() {
4899 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4903 * Is this user's e-mail address valid-looking and confirmed within
4904 * limits of the current site configuration?
4906 * @note If $wgEmailAuthentication is on, this may require the user to have
4907 * confirmed their address by returning a code or using a password
4908 * sent to the address from the wiki.
4912 public function isEmailConfirmed() {
4913 global $wgEmailAuthentication;
4915 // Avoid PHP 7.1 warning of passing $this by reference
4918 if ( Hooks
::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
4919 if ( $this->isAnon() ) {
4922 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4925 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4935 * Check whether there is an outstanding request for e-mail confirmation.
4938 public function isEmailConfirmationPending() {
4939 global $wgEmailAuthentication;
4940 return $wgEmailAuthentication &&
4941 !$this->isEmailConfirmed() &&
4942 $this->mEmailToken
&&
4943 $this->mEmailTokenExpires
> wfTimestamp();
4947 * Get the timestamp of account creation.
4949 * @return string|bool|null Timestamp of account creation, false for
4950 * non-existent/anonymous user accounts, or null if existing account
4951 * but information is not in database.
4953 public function getRegistration() {
4954 if ( $this->isAnon() ) {
4958 return $this->mRegistration
;
4962 * Get the timestamp of the first edit
4964 * @return string|bool Timestamp of first edit, or false for
4965 * non-existent/anonymous user accounts.
4967 public function getFirstEditTimestamp() {
4968 if ( $this->getId() == 0 ) {
4969 return false; // anons
4971 $dbr = wfGetDB( DB_REPLICA
);
4972 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
4973 $tsField = isset( $actorWhere['tables']['temp_rev_user'] )
4974 ?
'revactor_timestamp' : 'rev_timestamp';
4975 $time = $dbr->selectField(
4976 [ 'revision' ] +
$actorWhere['tables'],
4978 [ $actorWhere['conds'] ],
4980 [ 'ORDER BY' => "$tsField ASC" ],
4981 $actorWhere['joins']
4984 return false; // no edits
4986 return wfTimestamp( TS_MW
, $time );
4990 * Get the permissions associated with a given list of groups
4992 * @param array $groups Array of Strings List of internal group names
4993 * @return array Array of Strings List of permission key names for given groups combined
4995 public static function getGroupPermissions( $groups ) {
4996 global $wgGroupPermissions, $wgRevokePermissions;
4998 // grant every granted permission first
4999 foreach ( $groups as $group ) {
5000 if ( isset( $wgGroupPermissions[$group] ) ) {
5001 $rights = array_merge( $rights,
5002 // array_filter removes empty items
5003 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
5006 // now revoke the revoked permissions
5007 foreach ( $groups as $group ) {
5008 if ( isset( $wgRevokePermissions[$group] ) ) {
5009 $rights = array_diff( $rights,
5010 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
5013 return array_unique( $rights );
5017 * Get all the groups who have a given permission
5019 * @param string $role Role to check
5020 * @return array Array of Strings List of internal group names with the given permission
5022 public static function getGroupsWithPermission( $role ) {
5023 global $wgGroupPermissions;
5024 $allowedGroups = [];
5025 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
5026 if ( self
::groupHasPermission( $group, $role ) ) {
5027 $allowedGroups[] = $group;
5030 return $allowedGroups;
5034 * Check, if the given group has the given permission
5036 * If you're wanting to check whether all users have a permission, use
5037 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
5041 * @param string $group Group to check
5042 * @param string $role Role to check
5045 public static function groupHasPermission( $group, $role ) {
5046 global $wgGroupPermissions, $wgRevokePermissions;
5047 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
5048 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
5052 * Check if all users may be assumed to have the given permission
5054 * We generally assume so if the right is granted to '*' and isn't revoked
5055 * on any group. It doesn't attempt to take grants or other extension
5056 * limitations on rights into account in the general case, though, as that
5057 * would require it to always return false and defeat the purpose.
5058 * Specifically, session-based rights restrictions (such as OAuth or bot
5059 * passwords) are applied based on the current session.
5062 * @param string $right Right to check
5065 public static function isEveryoneAllowed( $right ) {
5066 global $wgGroupPermissions, $wgRevokePermissions;
5069 // Use the cached results, except in unit tests which rely on
5070 // being able change the permission mid-request
5071 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
5072 return $cache[$right];
5075 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
5076 $cache[$right] = false;
5080 // If it's revoked anywhere, then everyone doesn't have it
5081 foreach ( $wgRevokePermissions as $rights ) {
5082 if ( isset( $rights[$right] ) && $rights[$right] ) {
5083 $cache[$right] = false;
5088 // Remove any rights that aren't allowed to the global-session user,
5089 // unless there are no sessions for this endpoint.
5090 if ( !defined( 'MW_NO_SESSION' ) ) {
5091 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
5092 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
5093 $cache[$right] = false;
5098 // Allow extensions to say false
5099 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
5100 $cache[$right] = false;
5104 $cache[$right] = true;
5109 * Get the localized descriptive name for a group, if it exists
5110 * @deprecated since 1.29 Use UserGroupMembership::getGroupName instead
5112 * @param string $group Internal group name
5113 * @return string Localized descriptive group name
5115 public static function getGroupName( $group ) {
5116 wfDeprecated( __METHOD__
, '1.29' );
5117 return UserGroupMembership
::getGroupName( $group );
5121 * Get the localized descriptive name for a member of a group, if it exists
5122 * @deprecated since 1.29 Use UserGroupMembership::getGroupMemberName instead
5124 * @param string $group Internal group name
5125 * @param string $username Username for gender (since 1.19)
5126 * @return string Localized name for group member
5128 public static function getGroupMember( $group, $username = '#' ) {
5129 wfDeprecated( __METHOD__
, '1.29' );
5130 return UserGroupMembership
::getGroupMemberName( $group, $username );
5134 * Return the set of defined explicit groups.
5135 * The implicit groups (by default *, 'user' and 'autoconfirmed')
5136 * are not included, as they are defined automatically, not in the database.
5137 * @return array Array of internal group names
5139 public static function getAllGroups() {
5140 global $wgGroupPermissions, $wgRevokePermissions;
5141 return array_values( array_diff(
5142 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
5143 self
::getImplicitGroups()
5148 * Get a list of all available permissions.
5149 * @return string[] Array of permission names
5151 public static function getAllRights() {
5152 if ( self
::$mAllRights === false ) {
5153 global $wgAvailableRights;
5154 if ( count( $wgAvailableRights ) ) {
5155 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
5157 self
::$mAllRights = self
::$mCoreRights;
5159 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
5161 return self
::$mAllRights;
5165 * Get a list of implicit groups
5166 * TODO: Should we deprecate this? It's trivial, but we don't want to encourage use of globals.
5168 * @return array Array of Strings Array of internal group names
5170 public static function getImplicitGroups() {
5171 global $wgImplicitGroups;
5172 return $wgImplicitGroups;
5176 * Get the title of a page describing a particular group
5177 * @deprecated since 1.29 Use UserGroupMembership::getGroupPage instead
5179 * @param string $group Internal group name
5180 * @return Title|bool Title of the page if it exists, false otherwise
5182 public static function getGroupPage( $group ) {
5183 wfDeprecated( __METHOD__
, '1.29' );
5184 return UserGroupMembership
::getGroupPage( $group );
5188 * Create a link to the group in HTML, if available;
5189 * else return the group name.
5190 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5191 * make the link yourself if you need custom text
5193 * @param string $group Internal name of the group
5194 * @param string $text The text of the link
5195 * @return string HTML link to the group
5197 public static function makeGroupLinkHTML( $group, $text = '' ) {
5198 wfDeprecated( __METHOD__
, '1.29' );
5200 if ( $text == '' ) {
5201 $text = UserGroupMembership
::getGroupName( $group );
5203 $title = UserGroupMembership
::getGroupPage( $group );
5205 return MediaWikiServices
::getInstance()
5206 ->getLinkRenderer()->makeLink( $title, $text );
5208 return htmlspecialchars( $text );
5213 * Create a link to the group in Wikitext, if available;
5214 * else return the group name.
5215 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5216 * make the link yourself if you need custom text
5218 * @param string $group Internal name of the group
5219 * @param string $text The text of the link
5220 * @return string Wikilink to the group
5222 public static function makeGroupLinkWiki( $group, $text = '' ) {
5223 wfDeprecated( __METHOD__
, '1.29' );
5225 if ( $text == '' ) {
5226 $text = UserGroupMembership
::getGroupName( $group );
5228 $title = UserGroupMembership
::getGroupPage( $group );
5230 $page = $title->getFullText();
5231 return "[[$page|$text]]";
5238 * Returns an array of the groups that a particular group can add/remove.
5240 * @param string $group The group to check for whether it can add/remove
5241 * @return array Array( 'add' => array( addablegroups ),
5242 * 'remove' => array( removablegroups ),
5243 * 'add-self' => array( addablegroups to self),
5244 * 'remove-self' => array( removable groups from self) )
5246 public static function changeableByGroup( $group ) {
5247 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
5256 if ( empty( $wgAddGroups[$group] ) ) {
5257 // Don't add anything to $groups
5258 } elseif ( $wgAddGroups[$group] === true ) {
5259 // You get everything
5260 $groups['add'] = self
::getAllGroups();
5261 } elseif ( is_array( $wgAddGroups[$group] ) ) {
5262 $groups['add'] = $wgAddGroups[$group];
5265 // Same thing for remove
5266 if ( empty( $wgRemoveGroups[$group] ) ) {
5268 } elseif ( $wgRemoveGroups[$group] === true ) {
5269 $groups['remove'] = self
::getAllGroups();
5270 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
5271 $groups['remove'] = $wgRemoveGroups[$group];
5274 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
5275 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
5276 foreach ( $wgGroupsAddToSelf as $key => $value ) {
5277 if ( is_int( $key ) ) {
5278 $wgGroupsAddToSelf['user'][] = $value;
5283 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
5284 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
5285 if ( is_int( $key ) ) {
5286 $wgGroupsRemoveFromSelf['user'][] = $value;
5291 // Now figure out what groups the user can add to him/herself
5292 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
5294 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
5295 // No idea WHY this would be used, but it's there
5296 $groups['add-self'] = self
::getAllGroups();
5297 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
5298 $groups['add-self'] = $wgGroupsAddToSelf[$group];
5301 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
5303 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
5304 $groups['remove-self'] = self
::getAllGroups();
5305 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
5306 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
5313 * Returns an array of groups that this user can add and remove
5314 * @return array Array( 'add' => array( addablegroups ),
5315 * 'remove' => array( removablegroups ),
5316 * 'add-self' => array( addablegroups to self),
5317 * 'remove-self' => array( removable groups from self) )
5319 public function changeableGroups() {
5320 if ( $this->isAllowed( 'userrights' ) ) {
5321 // This group gives the right to modify everything (reverse-
5322 // compatibility with old "userrights lets you change
5324 // Using array_merge to make the groups reindexed
5325 $all = array_merge( self
::getAllGroups() );
5334 // Okay, it's not so simple, we will have to go through the arrays
5341 $addergroups = $this->getEffectiveGroups();
5343 foreach ( $addergroups as $addergroup ) {
5344 $groups = array_merge_recursive(
5345 $groups, $this->changeableByGroup( $addergroup )
5347 $groups['add'] = array_unique( $groups['add'] );
5348 $groups['remove'] = array_unique( $groups['remove'] );
5349 $groups['add-self'] = array_unique( $groups['add-self'] );
5350 $groups['remove-self'] = array_unique( $groups['remove-self'] );
5356 * Schedule a deferred update to update the user's edit count
5358 public function incEditCount() {
5359 if ( $this->isAnon() ) {
5363 DeferredUpdates
::addUpdate(
5364 new UserEditCountUpdate( $this, 1 ),
5365 DeferredUpdates
::POSTSEND
5370 * This method should not be called outside User/UserEditCountUpdate
5374 public function setEditCountInternal( $count ) {
5375 $this->mEditCount
= $count;
5379 * Initialize user_editcount from data out of the revision table
5381 * This method should not be called outside User/UserEditCountUpdate
5383 * @return int Number of edits
5385 public function initEditCountInternal() {
5386 // Pull from a replica DB to be less cruel to servers
5387 // Accuracy isn't the point anyway here
5388 $dbr = wfGetDB( DB_REPLICA
);
5389 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5390 $count = (int)$dbr->selectField(
5391 [ 'revision' ] +
$actorWhere['tables'],
5393 [ $actorWhere['conds'] ],
5396 $actorWhere['joins']
5399 $dbw = wfGetDB( DB_MASTER
);
5402 [ 'user_editcount' => $count ],
5404 'user_id' => $this->getId(),
5405 'user_editcount IS NULL OR user_editcount < ' . (int)$count
5414 * Get the description of a given right
5417 * @param string $right Right to query
5418 * @return string Localized description of the right
5420 public static function getRightDescription( $right ) {
5421 $key = "right-$right";
5422 $msg = wfMessage( $key );
5423 return $msg->isDisabled() ?
$right : $msg->text();
5427 * Get the name of a given grant
5430 * @param string $grant Grant to query
5431 * @return string Localized name of the grant
5433 public static function getGrantName( $grant ) {
5434 $key = "grant-$grant";
5435 $msg = wfMessage( $key );
5436 return $msg->isDisabled() ?
$grant : $msg->text();
5440 * Add a newuser log entry for this user.
5441 * Before 1.19 the return value was always true.
5443 * @deprecated since 1.27, AuthManager handles logging
5444 * @param string|bool $action Account creation type.
5445 * - String, one of the following values:
5446 * - 'create' for an anonymous user creating an account for himself.
5447 * This will force the action's performer to be the created user itself,
5448 * no matter the value of $wgUser
5449 * - 'create2' for a logged in user creating an account for someone else
5450 * - 'byemail' when the created user will receive its password by e-mail
5451 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5452 * - Boolean means whether the account was created by e-mail (deprecated):
5453 * - true will be converted to 'byemail'
5454 * - false will be converted to 'create' if this object is the same as
5455 * $wgUser and to 'create2' otherwise
5456 * @param string $reason User supplied reason
5459 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5460 return true; // disabled
5464 * Add an autocreate newuser log entry for this user
5465 * Used by things like CentralAuth and perhaps other authplugins.
5466 * Consider calling addNewUserLogEntry() directly instead.
5468 * @deprecated since 1.27, AuthManager handles logging
5471 public function addNewUserLogEntryAutoCreate() {
5472 $this->addNewUserLogEntry( 'autocreate' );
5478 * Load the user options either from cache, the database or an array
5480 * @param array|null $data Rows for the current user out of the user_properties table
5482 protected function loadOptions( $data = null ) {
5485 if ( $this->mOptionsLoaded
) {
5489 $this->mOptions
= self
::getDefaultOptions();
5491 if ( !$this->getId() ) {
5492 // For unlogged-in users, load language/variant options from request.
5493 // There's no need to do it for logged-in users: they can set preferences,
5494 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5495 // so don't override user's choice (especially when the user chooses site default).
5496 $variant = MediaWikiServices
::getInstance()->getContentLanguage()->getDefaultVariant();
5497 $this->mOptions
['variant'] = $variant;
5498 $this->mOptions
['language'] = $variant;
5499 $this->mOptionsLoaded
= true;
5503 // Maybe load from the object
5504 if ( !is_null( $this->mOptionOverrides
) ) {
5505 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5506 foreach ( $this->mOptionOverrides
as $key => $value ) {
5507 $this->mOptions
[$key] = $value;
5510 if ( !is_array( $data ) ) {
5511 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5512 // Load from database
5513 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5514 ?
wfGetDB( DB_MASTER
)
5515 : wfGetDB( DB_REPLICA
);
5517 $res = $dbr->select(
5519 [ 'up_property', 'up_value' ],
5520 [ 'up_user' => $this->getId() ],
5524 $this->mOptionOverrides
= [];
5526 foreach ( $res as $row ) {
5527 // Convert '0' to 0. PHP's boolean conversion considers them both
5528 // false, but e.g. JavaScript considers the former as true.
5529 // @todo: T54542 Somehow determine the desired type (string/int/bool)
5530 // and convert all values here.
5531 if ( $row->up_value
=== '0' ) {
5534 $data[$row->up_property
] = $row->up_value
;
5538 foreach ( $data as $property => $value ) {
5539 $this->mOptionOverrides
[$property] = $value;
5540 $this->mOptions
[$property] = $value;
5544 // Replace deprecated language codes
5545 $this->mOptions
['language'] = LanguageCode
::replaceDeprecatedCodes(
5546 $this->mOptions
['language']
5549 $this->mOptionsLoaded
= true;
5551 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5555 * Saves the non-default options for this user, as previously set e.g. via
5556 * setOption(), in the database's "user_properties" (preferences) table.
5557 * Usually used via saveSettings().
5559 protected function saveOptions() {
5560 $this->loadOptions();
5562 // Not using getOptions(), to keep hidden preferences in database
5563 $saveOptions = $this->mOptions
;
5565 // Allow hooks to abort, for instance to save to a global profile.
5566 // Reset options to default state before saving.
5567 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5571 $userId = $this->getId();
5573 $insert_rows = []; // all the new preference rows
5574 foreach ( $saveOptions as $key => $value ) {
5575 // Don't bother storing default values
5576 $defaultOption = self
::getDefaultOption( $key );
5577 if ( ( $defaultOption === null && $value !== false && $value !== null )
5578 ||
$value != $defaultOption
5581 'up_user' => $userId,
5582 'up_property' => $key,
5583 'up_value' => $value,
5588 $dbw = wfGetDB( DB_MASTER
);
5590 $res = $dbw->select( 'user_properties',
5591 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5593 // Find prior rows that need to be removed or updated. These rows will
5594 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5596 foreach ( $res as $row ) {
5597 if ( !isset( $saveOptions[$row->up_property
] )
5598 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5600 $keysDelete[] = $row->up_property
;
5604 if ( count( $keysDelete ) ) {
5605 // Do the DELETE by PRIMARY KEY for prior rows.
5606 // In the past a very large portion of calls to this function are for setting
5607 // 'rememberpassword' for new accounts (a preference that has since been removed).
5608 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5609 // caused gap locks on [max user ID,+infinity) which caused high contention since
5610 // updates would pile up on each other as they are for higher (newer) user IDs.
5611 // It might not be necessary these days, but it shouldn't hurt either.
5612 $dbw->delete( 'user_properties',
5613 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5615 // Insert the new preference rows
5616 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5620 * Return the list of user fields that should be selected to create
5621 * a new user object.
5622 * @deprecated since 1.31, use self::getQueryInfo() instead.
5625 public static function selectFields() {
5626 wfDeprecated( __METHOD__
, '1.31' );
5634 'user_email_authenticated',
5636 'user_email_token_expires',
5637 'user_registration',
5643 * Return the tables, fields, and join conditions to be selected to create
5644 * a new user object.
5646 * @return array With three keys:
5647 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
5648 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
5649 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
5651 public static function getQueryInfo() {
5652 global $wgActorTableSchemaMigrationStage;
5655 'tables' => [ 'user' ],
5663 'user_email_authenticated',
5665 'user_email_token_expires',
5666 'user_registration',
5672 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
5673 // but it does little harm and might be needed for write callers loading a User.
5674 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
5675 $ret['tables']['user_actor'] = 'actor';
5676 $ret['fields'][] = 'user_actor.actor_id';
5677 $ret['joins']['user_actor'] = [
5678 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) ?
'JOIN' : 'LEFT JOIN',
5679 [ 'user_actor.actor_user = user_id' ]
5687 * Factory function for fatal permission-denied errors
5690 * @param string $permission User right required
5693 static function newFatalPermissionDeniedStatus( $permission ) {
5697 foreach ( self
::getGroupsWithPermission( $permission ) as $group ) {
5698 $groups[] = UserGroupMembership
::getLink( $group, RequestContext
::getMain(), 'wiki' );
5702 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5704 return Status
::newFatal( 'badaccess-group0' );
5709 * Get a new instance of this user that was loaded from the master via a locking read
5711 * Use this instead of the main context User when updating that user. This avoids races
5712 * where that user was loaded from a replica DB or even the master but without proper locks.
5714 * @return User|null Returns null if the user was not found in the DB
5717 public function getInstanceForUpdate() {
5718 if ( !$this->getId() ) {
5719 return null; // anon
5722 $user = self
::newFromId( $this->getId() );
5723 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5731 * Checks if two user objects point to the same user.
5733 * @since 1.25 ; takes a UserIdentity instead of a User since 1.32
5734 * @param UserIdentity $user
5737 public function equals( UserIdentity
$user ) {
5738 // XXX it's not clear whether central ID providers are supposed to obey this
5739 return $this->getName() === $user->getName();