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 * Global constant made accessible as class constants so that autoloader
61 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
63 const EDIT_TOKEN_SUFFIX
= Token
::SUFFIX
;
66 * @const int Serialized record version.
71 * Exclude user options that are set to their default value.
74 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
79 const CHECK_USER_RIGHTS
= true;
84 const IGNORE_USER_RIGHTS
= false;
87 * Array of Strings List of member variables which are saved to the
88 * shared cache (memcached). Any operation which changes the
89 * corresponding database fields must call a cache-clearing function.
92 protected static $mCacheVars = [
100 'mEmailAuthenticated',
102 'mEmailTokenExpires',
107 // user_properties table
114 * Array of Strings Core rights.
115 * Each of these should have a corresponding message of the form
119 protected static $mCoreRights = [
167 'move-categorypages',
168 'move-rootuserpages',
172 'override-export-depth',
194 'userrights-interwiki',
202 * String Cached results of getAllRights()
204 protected static $mAllRights = false;
206 /** Cache variables */
219 /** @var string TS_MW timestamp from the DB */
221 /** @var string TS_MW timestamp from cache */
222 protected $mQuickTouched;
226 public $mEmailAuthenticated;
228 protected $mEmailToken;
230 protected $mEmailTokenExpires;
232 protected $mRegistration;
234 protected $mEditCount;
235 /** @var UserGroupMembership[] Associative array of (group name => UserGroupMembership object) */
236 protected $mGroupMemberships;
238 protected $mOptionOverrides;
242 * Bool Whether the cache variables have been loaded.
245 public $mOptionsLoaded;
248 * Array with already loaded items or true if all items have been loaded.
250 protected $mLoadedItems = [];
254 * String Initialization data source if mLoadedItems!==true. May be one of:
255 * - 'defaults' anonymous user initialised from class defaults
256 * - 'name' initialise from mName
257 * - 'id' initialise from mId
258 * - 'actor' initialise from mActorId
259 * - 'session' log in from session if possible
261 * Use the User::newFrom*() family of functions to set this.
266 * Lazy-initialized variables, invalidated with clearInstanceCache
270 protected $mDatePreference;
278 protected $mBlockreason;
280 protected $mEffectiveGroups;
282 protected $mImplicitGroups;
284 protected $mFormerGroups;
286 protected $mGlobalBlock;
294 /** @var WebRequest */
301 protected $mAllowUsertalk;
304 private $mBlockedFromCreateAccount = false;
306 /** @var int User::READ_* constant bitfield used to load data */
307 protected $queryFlagsUsed = self
::READ_NORMAL
;
309 public static $idCacheByName = [];
312 * Lightweight constructor for an anonymous user.
313 * Use the User::newFrom* factory functions for other kinds of users.
317 * @see newFromActorId()
318 * @see newFromConfirmationCode()
319 * @see newFromSession()
322 public function __construct() {
323 $this->clearInstanceCache( 'defaults' );
329 public function __toString() {
330 return (string)$this->getName();
334 * Test if it's safe to load this User object.
336 * You should typically check this before using $wgUser or
337 * RequestContext::getUser in a method that might be called before the
338 * system has been fully initialized. If the object is unsafe, you should
339 * use an anonymous user:
341 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
347 public function isSafeToLoad() {
348 global $wgFullyInitialised;
350 // The user is safe to load if:
351 // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
352 // * mLoadedItems === true (already loaded)
353 // * mFrom !== 'session' (sessions not involved at all)
355 return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
356 $this->mLoadedItems
=== true ||
$this->mFrom
!== 'session';
360 * Load the user table data for this object from the source given by mFrom.
362 * @param int $flags User::READ_* constant bitfield
364 public function load( $flags = self
::READ_NORMAL
) {
365 global $wgFullyInitialised;
367 if ( $this->mLoadedItems
=== true ) {
371 // Set it now to avoid infinite recursion in accessors
372 $oldLoadedItems = $this->mLoadedItems
;
373 $this->mLoadedItems
= true;
374 $this->queryFlagsUsed
= $flags;
376 // If this is called too early, things are likely to break.
377 if ( !$wgFullyInitialised && $this->mFrom
=== 'session' ) {
378 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
379 ->warning( 'User::loadFromSession called before the end of Setup.php', [
380 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
382 $this->loadDefaults();
383 $this->mLoadedItems
= $oldLoadedItems;
387 switch ( $this->mFrom
) {
389 $this->loadDefaults();
392 // Make sure this thread sees its own changes
393 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
394 if ( $lb->hasOrMadeRecentMasterChanges() ) {
395 $flags |
= self
::READ_LATEST
;
396 $this->queryFlagsUsed
= $flags;
399 $this->mId
= self
::idFromName( $this->mName
, $flags );
401 // Nonexistent user placeholder object
402 $this->loadDefaults( $this->mName
);
404 $this->loadFromId( $flags );
408 // Make sure this thread sees its own changes, if the ID isn't 0
409 if ( $this->mId
!= 0 ) {
410 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
411 if ( $lb->hasOrMadeRecentMasterChanges() ) {
412 $flags |
= self
::READ_LATEST
;
413 $this->queryFlagsUsed
= $flags;
417 $this->loadFromId( $flags );
420 // Make sure this thread sees its own changes
421 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
422 if ( $lb->hasOrMadeRecentMasterChanges() ) {
423 $flags |
= self
::READ_LATEST
;
424 $this->queryFlagsUsed
= $flags;
427 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
428 $row = wfGetDB( $index )->selectRow(
430 [ 'actor_user', 'actor_name' ],
431 [ 'actor_id' => $this->mActorId
],
438 $this->loadDefaults();
439 } elseif ( $row->actor_user
) {
440 $this->mId
= $row->actor_user
;
441 $this->loadFromId( $flags );
443 $this->loadDefaults( $row->actor_name
);
447 if ( !$this->loadFromSession() ) {
448 // Loading from session failed. Load defaults.
449 $this->loadDefaults();
451 Hooks
::run( 'UserLoadAfterLoadFromSession', [ $this ] );
454 throw new UnexpectedValueException(
455 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
460 * Load user table data, given mId has already been set.
461 * @param int $flags User::READ_* constant bitfield
462 * @return bool False if the ID does not exist, true otherwise
464 public function loadFromId( $flags = self
::READ_NORMAL
) {
465 if ( $this->mId
== 0 ) {
466 // Anonymous users are not in the database (don't need cache)
467 $this->loadDefaults();
471 // Try cache (unless this needs data from the master DB).
472 // NOTE: if this thread called saveSettings(), the cache was cleared.
473 $latest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
475 if ( !$this->loadFromDatabase( $flags ) ) {
476 // Can't load from ID
480 $this->loadFromCache();
483 $this->mLoadedItems
= true;
484 $this->queryFlagsUsed
= $flags;
491 * @param string $wikiId
494 public static function purge( $wikiId, $userId ) {
495 $cache = ObjectCache
::getMainWANInstance();
496 $key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
497 $cache->delete( $key );
502 * @param WANObjectCache $cache
505 protected function getCacheKey( WANObjectCache
$cache ) {
506 return $cache->makeGlobalKey( 'user', 'id', wfWikiID(), $this->mId
);
510 * @param WANObjectCache $cache
514 public function getMutableCacheKeys( WANObjectCache
$cache ) {
515 $id = $this->getId();
517 return $id ?
[ $this->getCacheKey( $cache ) ] : [];
521 * Load user data from shared cache, given mId has already been set.
526 protected function loadFromCache() {
527 $cache = ObjectCache
::getMainWANInstance();
528 $data = $cache->getWithSetCallback(
529 $this->getCacheKey( $cache ),
531 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
532 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
533 wfDebug( "User: cache miss for user {$this->mId}\n" );
535 $this->loadFromDatabase( self
::READ_NORMAL
);
537 $this->loadOptions();
540 foreach ( self
::$mCacheVars as $name ) {
541 $data[$name] = $this->$name;
544 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->mTouched
), $ttl );
546 // if a user group membership is about to expire, the cache needs to
547 // expire at that time (T163691)
548 foreach ( $this->mGroupMemberships
as $ugm ) {
549 if ( $ugm->getExpiry() ) {
550 $secondsUntilExpiry = wfTimestamp( TS_UNIX
, $ugm->getExpiry() ) - time();
551 if ( $secondsUntilExpiry > 0 && $secondsUntilExpiry < $ttl ) {
552 $ttl = $secondsUntilExpiry;
559 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'version' => self
::VERSION
]
562 // Restore from cache
563 foreach ( self
::$mCacheVars as $name ) {
564 $this->$name = $data[$name];
570 /** @name newFrom*() static factory methods */
574 * Static factory method for creation from username.
576 * This is slightly less efficient than newFromId(), so use newFromId() if
577 * you have both an ID and a name handy.
579 * @param string $name Username, validated by Title::newFromText()
580 * @param string|bool $validate Validate username. Takes the same parameters as
581 * User::getCanonicalName(), except that true is accepted as an alias
582 * for 'valid', for BC.
584 * @return User|bool User object, or false if the username is invalid
585 * (e.g. if it contains illegal characters or is an IP address). If the
586 * username is not present in the database, the result will be a user object
587 * with a name, zero user ID and default settings.
589 public static function newFromName( $name, $validate = 'valid' ) {
590 if ( $validate === true ) {
593 $name = self
::getCanonicalName( $name, $validate );
594 if ( $name === false ) {
597 // Create unloaded user object
601 $u->setItemLoaded( 'name' );
607 * Static factory method for creation from a given user ID.
609 * @param int $id Valid user ID
610 * @return User The corresponding User object
612 public static function newFromId( $id ) {
616 $u->setItemLoaded( 'id' );
621 * Static factory method for creation from a given actor ID.
624 * @param int $id Valid actor ID
625 * @return User The corresponding User object
627 public static function newFromActorId( $id ) {
628 global $wgActorTableSchemaMigrationStage;
630 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
631 // but it does little harm and might be needed for write callers loading a User.
632 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) ) {
633 throw new BadMethodCallException(
634 'Cannot use ' . __METHOD__
635 . ' when $wgActorTableSchemaMigrationStage lacks SCHEMA_COMPAT_NEW'
642 $u->setItemLoaded( 'actor' );
647 * Returns a User object corresponding to the given UserIdentity.
651 * @param UserIdentity $identity
655 public static function newFromIdentity( UserIdentity
$identity ) {
656 if ( $identity instanceof User
) {
660 return self
::newFromAnyId(
661 $identity->getId() === 0 ?
null : $identity->getId(),
662 $identity->getName() === '' ?
null : $identity->getName(),
663 $identity->getActorId() === 0 ?
null : $identity->getActorId()
668 * Static factory method for creation from an ID, name, and/or actor ID
670 * This does not check that the ID, name, and actor ID all correspond to
674 * @param int|null $userId User ID, if known
675 * @param string|null $userName User name, if known
676 * @param int|null $actorId Actor ID, if known
679 public static function newFromAnyId( $userId, $userName, $actorId ) {
680 global $wgActorTableSchemaMigrationStage;
683 $user->mFrom
= 'defaults';
685 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
686 // but it does little harm and might be needed for write callers loading a User.
687 if ( ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) && $actorId !== null ) {
688 $user->mActorId
= (int)$actorId;
689 if ( $user->mActorId
!== 0 ) {
690 $user->mFrom
= 'actor';
692 $user->setItemLoaded( 'actor' );
695 if ( $userName !== null && $userName !== '' ) {
696 $user->mName
= $userName;
697 $user->mFrom
= 'name';
698 $user->setItemLoaded( 'name' );
701 if ( $userId !== null ) {
702 $user->mId
= (int)$userId;
703 if ( $user->mId
!== 0 ) {
706 $user->setItemLoaded( 'id' );
709 if ( $user->mFrom
=== 'defaults' ) {
710 throw new InvalidArgumentException(
711 'Cannot create a user with no name, no ID, and no actor ID'
719 * Factory method to fetch whichever user has a given email confirmation code.
720 * This code is generated when an account is created or its e-mail address
723 * If the code is invalid or has expired, returns NULL.
725 * @param string $code Confirmation code
726 * @param int $flags User::READ_* bitfield
729 public static function newFromConfirmationCode( $code, $flags = 0 ) {
730 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
731 ?
wfGetDB( DB_MASTER
)
732 : wfGetDB( DB_REPLICA
);
734 $id = $db->selectField(
738 'user_email_token' => md5( $code ),
739 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
743 return $id ? self
::newFromId( $id ) : null;
747 * Create a new user object using data from session. If the login
748 * credentials are invalid, the result is an anonymous user.
750 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
753 public static function newFromSession( WebRequest
$request = null ) {
755 $user->mFrom
= 'session';
756 $user->mRequest
= $request;
761 * Create a new user object from a user row.
762 * The row should have the following fields from the user table in it:
763 * - either user_name or user_id to load further data if needed (or both)
765 * - all other fields (email, etc.)
766 * It is useless to provide the remaining fields if either user_id,
767 * user_name and user_real_name are not provided because the whole row
768 * will be loaded once more from the database when accessing them.
770 * @param stdClass $row A row from the user table
771 * @param array|null $data Further data to load into the object
772 * (see User::loadFromRow for valid keys)
775 public static function newFromRow( $row, $data = null ) {
777 $user->loadFromRow( $row, $data );
782 * Static factory method for creation of a "system" user from username.
784 * A "system" user is an account that's used to attribute logged actions
785 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
786 * might include the 'Maintenance script' or 'Conversion script' accounts
787 * used by various scripts in the maintenance/ directory or accounts such
788 * as 'MediaWiki message delivery' used by the MassMessage extension.
790 * This can optionally create the user if it doesn't exist, and "steal" the
791 * account if it does exist.
793 * "Stealing" an existing user is intended to make it impossible for normal
794 * authentication processes to use the account, effectively disabling the
795 * account for normal use:
796 * - Email is invalidated, to prevent account recovery by emailing a
797 * temporary password and to disassociate the account from the existing
799 * - The token is set to a magic invalid value, to kill existing sessions
800 * and to prevent $this->setToken() calls from resetting the token to a
802 * - SessionManager is instructed to prevent new sessions for the user, to
803 * do things like deauthorizing OAuth consumers.
804 * - AuthManager is instructed to revoke access, to invalidate or remove
805 * passwords and other credentials.
807 * @param string $name Username
808 * @param array $options Options are:
809 * - validate: As for User::getCanonicalName(), default 'valid'
810 * - create: Whether to create the user if it doesn't already exist, default true
811 * - steal: Whether to "disable" the account for normal use if it already
812 * exists, default false
816 public static function newSystemUser( $name, $options = [] ) {
818 'validate' => 'valid',
823 $name = self
::getCanonicalName( $name, $options['validate'] );
824 if ( $name === false ) {
828 $dbr = wfGetDB( DB_REPLICA
);
829 $userQuery = self
::getQueryInfo();
830 $row = $dbr->selectRow(
831 $userQuery['tables'],
832 $userQuery['fields'],
833 [ 'user_name' => $name ],
839 // Try the master database...
840 $dbw = wfGetDB( DB_MASTER
);
841 $row = $dbw->selectRow(
842 $userQuery['tables'],
843 $userQuery['fields'],
844 [ 'user_name' => $name ],
852 // No user. Create it?
853 return $options['create']
854 ? self
::createNew( $name, [ 'token' => self
::INVALID_TOKEN
] )
858 $user = self
::newFromRow( $row );
860 // A user is considered to exist as a non-system user if it can
861 // authenticate, or has an email set, or has a non-invalid token.
862 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
863 AuthManager
::singleton()->userCanAuthenticate( $name )
865 // User exists. Steal it?
866 if ( !$options['steal'] ) {
870 AuthManager
::singleton()->revokeAccessForUser( $name );
872 $user->invalidateEmail();
873 $user->mToken
= self
::INVALID_TOKEN
;
874 $user->saveSettings();
875 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
884 * Get the username corresponding to a given user ID
885 * @param int $id User ID
886 * @return string|bool The corresponding username
888 public static function whoIs( $id ) {
889 return UserCache
::singleton()->getProp( $id, 'name' );
893 * Get the real name of a user given their user ID
895 * @param int $id User ID
896 * @return string|bool The corresponding user's real name
898 public static function whoIsReal( $id ) {
899 return UserCache
::singleton()->getProp( $id, 'real_name' );
903 * Get database id given a user name
904 * @param string $name Username
905 * @param int $flags User::READ_* constant bitfield
906 * @return int|null The corresponding user's ID, or null if user is nonexistent
908 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
909 $nt = Title
::makeTitleSafe( NS_USER
, $name );
910 if ( is_null( $nt ) ) {
915 if ( !( $flags & self
::READ_LATEST
) && array_key_exists( $name, self
::$idCacheByName ) ) {
916 return self
::$idCacheByName[$name];
919 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
920 $db = wfGetDB( $index );
925 [ 'user_name' => $nt->getText() ],
930 if ( $s === false ) {
933 $result = $s->user_id
;
936 self
::$idCacheByName[$name] = $result;
938 if ( count( self
::$idCacheByName ) > 1000 ) {
939 self
::$idCacheByName = [];
946 * Reset the cache used in idFromName(). For use in tests.
948 public static function resetIdByNameCache() {
949 self
::$idCacheByName = [];
953 * Does the string match an anonymous IP address?
955 * This function exists for username validation, in order to reject
956 * usernames which are similar in form to IP addresses. Strings such
957 * as 300.300.300.300 will return true because it looks like an IP
958 * address, despite not being strictly valid.
960 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
961 * address because the usemod software would "cloak" anonymous IP
962 * addresses like this, if we allowed accounts like this to be created
963 * new users could get the old edits of these anonymous users.
965 * @param string $name Name to match
968 public static function isIP( $name ) {
969 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
970 || IP
::isIPv6( $name );
974 * Is the user an IP range?
979 public function isIPRange() {
980 return IP
::isValidRange( $this->mName
);
984 * Is the input a valid username?
986 * Checks if the input is a valid username, we don't want an empty string,
987 * an IP address, anything that contains slashes (would mess up subpages),
988 * is longer than the maximum allowed username size or doesn't begin with
991 * @param string $name Name to match
994 public static function isValidUserName( $name ) {
995 global $wgMaxNameChars;
998 || self
::isIP( $name )
999 ||
strpos( $name, '/' ) !== false
1000 ||
strlen( $name ) > $wgMaxNameChars
1001 ||
$name != MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name )
1006 // Ensure that the name can't be misresolved as a different title,
1007 // such as with extra namespace keys at the start.
1008 $parsed = Title
::newFromText( $name );
1009 if ( is_null( $parsed )
1010 ||
$parsed->getNamespace()
1011 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
1015 // Check an additional blacklist of troublemaker characters.
1016 // Should these be merged into the title char list?
1017 $unicodeBlacklist = '/[' .
1018 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
1019 '\x{00a0}' . # non-breaking space
1020 '\x{2000}-\x{200f}' . # various whitespace
1021 '\x{2028}-\x{202f}' . # breaks and control chars
1022 '\x{3000}' . # ideographic space
1023 '\x{e000}-\x{f8ff}' . # private use
1025 if ( preg_match( $unicodeBlacklist, $name ) ) {
1033 * Usernames which fail to pass this function will be blocked
1034 * from user login and new account registrations, but may be used
1035 * internally by batch processes.
1037 * If an account already exists in this form, login will be blocked
1038 * by a failure to pass this function.
1040 * @param string $name Name to match
1043 public static function isUsableName( $name ) {
1044 global $wgReservedUsernames;
1045 // Must be a valid username, obviously ;)
1046 if ( !self
::isValidUserName( $name ) ) {
1050 static $reservedUsernames = false;
1051 if ( !$reservedUsernames ) {
1052 $reservedUsernames = $wgReservedUsernames;
1053 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
1056 // Certain names may be reserved for batch processes.
1057 foreach ( $reservedUsernames as $reserved ) {
1058 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
1059 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->plain();
1061 if ( $reserved == $name ) {
1069 * Return the users who are members of the given group(s). In case of multiple groups,
1070 * users who are members of at least one of them are returned.
1072 * @param string|array $groups A single group name or an array of group names
1073 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
1074 * records; larger values are ignored.
1075 * @param int|null $after ID the user to start after
1076 * @return UserArrayFromResult
1078 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
1079 if ( $groups === [] ) {
1080 return UserArrayFromResult
::newFromIDs( [] );
1083 $groups = array_unique( (array)$groups );
1084 $limit = min( 5000, $limit );
1086 $conds = [ 'ug_group' => $groups ];
1087 if ( $after !== null ) {
1088 $conds[] = 'ug_user > ' . (int)$after;
1091 $dbr = wfGetDB( DB_REPLICA
);
1092 $ids = $dbr->selectFieldValues(
1099 'ORDER BY' => 'ug_user',
1103 return UserArray
::newFromIDs( $ids );
1107 * Usernames which fail to pass this function will be blocked
1108 * from new account registrations, but may be used internally
1109 * either by batch processes or by user accounts which have
1110 * already been created.
1112 * Additional blacklisting may be added here rather than in
1113 * isValidUserName() to avoid disrupting existing accounts.
1115 * @param string $name String to match
1118 public static function isCreatableName( $name ) {
1119 global $wgInvalidUsernameCharacters;
1121 // Ensure that the username isn't longer than 235 bytes, so that
1122 // (at least for the builtin skins) user javascript and css files
1123 // will work. (T25080)
1124 if ( strlen( $name ) > 235 ) {
1125 wfDebugLog( 'username', __METHOD__
.
1126 ": '$name' invalid due to length" );
1130 // Preg yells if you try to give it an empty string
1131 if ( $wgInvalidUsernameCharacters !== '' ) {
1132 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
1133 wfDebugLog( 'username', __METHOD__
.
1134 ": '$name' invalid due to wgInvalidUsernameCharacters" );
1139 return self
::isUsableName( $name );
1143 * Is the input a valid password for this user?
1145 * @param string $password Desired password
1148 public function isValidPassword( $password ) {
1149 // simple boolean wrapper for getPasswordValidity
1150 return $this->getPasswordValidity( $password ) === true;
1154 * Given unvalidated password input, return error message on failure.
1156 * @param string $password Desired password
1157 * @return bool|string|array True on success, string or array of error message on failure
1159 public function getPasswordValidity( $password ) {
1160 $result = $this->checkPasswordValidity( $password );
1161 if ( $result->isGood() ) {
1165 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
1166 $messages[] = $error['message'];
1168 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
1169 $messages[] = $warning['message'];
1171 if ( count( $messages ) === 1 ) {
1172 return $messages[0];
1179 * Check if this is a valid password for this user
1181 * Create a Status object based on the password's validity.
1182 * The Status should be set to fatal if the user should not
1183 * be allowed to log in, and should have any errors that
1184 * would block changing the password.
1186 * If the return value of this is not OK, the password
1187 * should not be checked. If the return value is not Good,
1188 * the password can be checked, but the user should not be
1189 * able to set their password to this.
1191 * @param string $password Desired password
1195 public function checkPasswordValidity( $password ) {
1196 global $wgPasswordPolicy;
1198 $upp = new UserPasswordPolicy(
1199 $wgPasswordPolicy['policies'],
1200 $wgPasswordPolicy['checks']
1203 $status = Status
::newGood();
1204 $result = false; // init $result to false for the internal checks
1206 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1207 $status->error( $result );
1211 if ( $result === false ) {
1212 $status->merge( $upp->checkUserPassword( $this, $password ) );
1214 } elseif ( $result === true ) {
1217 $status->error( $result );
1218 return $status; // the isValidPassword hook set a string $result and returned true
1223 * Given unvalidated user input, return a canonical username, or false if
1224 * the username is invalid.
1225 * @param string $name User input
1226 * @param string|bool $validate Type of validation to use:
1227 * - false No validation
1228 * - 'valid' Valid for batch processes
1229 * - 'usable' Valid for batch processes and login
1230 * - 'creatable' Valid for batch processes, login and account creation
1232 * @throws InvalidArgumentException
1233 * @return bool|string
1235 public static function getCanonicalName( $name, $validate = 'valid' ) {
1236 // Force usernames to capital
1237 $name = MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name );
1239 # Reject names containing '#'; these will be cleaned up
1240 # with title normalisation, but then it's too late to
1242 if ( strpos( $name, '#' ) !== false ) {
1246 // Clean up name according to title rules,
1247 // but only when validation is requested (T14654)
1248 $t = ( $validate !== false ) ?
1249 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1250 // Check for invalid titles
1251 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1255 // Reject various classes of invalid names
1256 $name = AuthManager
::callLegacyAuthPlugin(
1257 'getCanonicalName', [ $t->getText() ], $t->getText()
1260 switch ( $validate ) {
1264 if ( !self
::isValidUserName( $name ) ) {
1269 if ( !self
::isUsableName( $name ) ) {
1274 if ( !self
::isCreatableName( $name ) ) {
1279 throw new InvalidArgumentException(
1280 'Invalid parameter value for $validate in ' . __METHOD__
);
1286 * Return a random password.
1288 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1289 * @return string New random password
1291 public static function randomPassword() {
1292 global $wgMinimalPasswordLength;
1293 return PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1297 * Set cached properties to default.
1299 * @note This no longer clears uncached lazy-initialised properties;
1300 * the constructor does that instead.
1302 * @param string|bool $name
1304 public function loadDefaults( $name = false ) {
1306 $this->mName
= $name;
1307 $this->mActorId
= null;
1308 $this->mRealName
= '';
1310 $this->mOptionOverrides
= null;
1311 $this->mOptionsLoaded
= false;
1313 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1314 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1315 if ( $loggedOut !== 0 ) {
1316 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1318 $this->mTouched
= '1'; # Allow any pages to be cached
1321 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1322 $this->mEmailAuthenticated
= null;
1323 $this->mEmailToken
= '';
1324 $this->mEmailTokenExpires
= null;
1325 $this->mRegistration
= wfTimestamp( TS_MW
);
1326 $this->mGroupMemberships
= [];
1328 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1332 * Return whether an item has been loaded.
1334 * @param string $item Item to check. Current possibilities:
1338 * @param string $all 'all' to check if the whole object has been loaded
1339 * or any other string to check if only the item is available (e.g.
1343 public function isItemLoaded( $item, $all = 'all' ) {
1344 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1345 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1349 * Set that an item has been loaded
1351 * @param string $item
1353 protected function setItemLoaded( $item ) {
1354 if ( is_array( $this->mLoadedItems
) ) {
1355 $this->mLoadedItems
[$item] = true;
1360 * Load user data from the session.
1362 * @return bool True if the user is logged in, false otherwise.
1364 private function loadFromSession() {
1367 Hooks
::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1368 if ( $result !== null ) {
1372 // MediaWiki\Session\Session already did the necessary authentication of the user
1373 // returned here, so just use it if applicable.
1374 $session = $this->getRequest()->getSession();
1375 $user = $session->getUser();
1376 if ( $user->isLoggedIn() ) {
1377 $this->loadFromUserObject( $user );
1378 if ( $user->isBlocked() ) {
1379 // If this user is autoblocked, set a cookie to track the Block. This has to be done on
1380 // every session load, because an autoblocked editor might not edit again from the same
1381 // IP address after being blocked.
1382 $this->trackBlockWithCookie();
1385 // Other code expects these to be set in the session, so set them.
1386 $session->set( 'wsUserID', $this->getId() );
1387 $session->set( 'wsUserName', $this->getName() );
1388 $session->set( 'wsToken', $this->getToken() );
1397 * Set the 'BlockID' cookie depending on block type and user authentication status.
1399 public function trackBlockWithCookie() {
1400 $block = $this->getBlock();
1401 if ( $block && $this->getRequest()->getCookie( 'BlockID' ) === null ) {
1402 $config = RequestContext
::getMain()->getConfig();
1403 $shouldSetCookie = false;
1405 if ( $this->isAnon() && $config->get( 'CookieSetOnIpBlock' ) ) {
1406 // If user is logged-out, set a cookie to track the Block
1407 $shouldSetCookie = in_array( $block->getType(), [
1408 Block
::TYPE_IP
, Block
::TYPE_RANGE
1410 if ( $shouldSetCookie ) {
1411 $block->setCookie( $this->getRequest()->response() );
1413 // temporary measure the use of cookies on ip blocks
1414 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1415 $stats->increment( 'block.ipblock.setCookie.success' );
1417 } elseif ( $this->isLoggedIn() && $config->get( 'CookieSetOnAutoblock' ) ) {
1418 $shouldSetCookie = $block->getType() === Block
::TYPE_USER
&& $block->isAutoblocking();
1419 if ( $shouldSetCookie ) {
1420 $block->setCookie( $this->getRequest()->response() );
1427 * Load user and user_group data from the database.
1428 * $this->mId must be set, this is how the user is identified.
1430 * @param int $flags User::READ_* constant bitfield
1431 * @return bool True if the user exists, false if the user is anonymous
1433 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1435 $this->mId
= intval( $this->mId
);
1437 if ( !$this->mId
) {
1438 // Anonymous users are not in the database
1439 $this->loadDefaults();
1443 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1444 $db = wfGetDB( $index );
1446 $userQuery = self
::getQueryInfo();
1447 $s = $db->selectRow(
1448 $userQuery['tables'],
1449 $userQuery['fields'],
1450 [ 'user_id' => $this->mId
],
1456 $this->queryFlagsUsed
= $flags;
1457 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1459 if ( $s !== false ) {
1460 // Initialise user table data
1461 $this->loadFromRow( $s );
1462 $this->mGroupMemberships
= null; // deferred
1463 $this->getEditCount(); // revalidation for nulls
1468 $this->loadDefaults();
1474 * Initialize this object from a row from the user table.
1476 * @param stdClass $row Row from the user table to load.
1477 * @param array|null $data Further user data to load into the object
1479 * user_groups Array of arrays or stdClass result rows out of the user_groups
1480 * table. Previously you were supposed to pass an array of strings
1481 * here, but we also need expiry info nowadays, so an array of
1482 * strings is ignored.
1483 * user_properties Array with properties out of the user_properties table
1485 protected function loadFromRow( $row, $data = null ) {
1486 global $wgActorTableSchemaMigrationStage;
1488 if ( !is_object( $row ) ) {
1489 throw new InvalidArgumentException( '$row must be an object' );
1494 $this->mGroupMemberships
= null; // deferred
1496 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
1497 // but it does little harm and might be needed for write callers loading a User.
1498 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
1499 if ( isset( $row->actor_id
) ) {
1500 $this->mActorId
= (int)$row->actor_id
;
1501 if ( $this->mActorId
!== 0 ) {
1502 $this->mFrom
= 'actor';
1504 $this->setItemLoaded( 'actor' );
1510 if ( isset( $row->user_name
) && $row->user_name
!== '' ) {
1511 $this->mName
= $row->user_name
;
1512 $this->mFrom
= 'name';
1513 $this->setItemLoaded( 'name' );
1518 if ( isset( $row->user_real_name
) ) {
1519 $this->mRealName
= $row->user_real_name
;
1520 $this->setItemLoaded( 'realname' );
1525 if ( isset( $row->user_id
) ) {
1526 $this->mId
= intval( $row->user_id
);
1527 if ( $this->mId
!== 0 ) {
1528 $this->mFrom
= 'id';
1530 $this->setItemLoaded( 'id' );
1535 if ( isset( $row->user_id
) && isset( $row->user_name
) && $row->user_name
!== '' ) {
1536 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1539 if ( isset( $row->user_editcount
) ) {
1540 $this->mEditCount
= $row->user_editcount
;
1545 if ( isset( $row->user_touched
) ) {
1546 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1551 if ( isset( $row->user_token
) ) {
1552 // The definition for the column is binary(32), so trim the NULs
1553 // that appends. The previous definition was char(32), so trim
1555 $this->mToken
= rtrim( $row->user_token
, " \0" );
1556 if ( $this->mToken
=== '' ) {
1557 $this->mToken
= null;
1563 if ( isset( $row->user_email
) ) {
1564 $this->mEmail
= $row->user_email
;
1565 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1566 $this->mEmailToken
= $row->user_email_token
;
1567 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1568 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1574 $this->mLoadedItems
= true;
1577 if ( is_array( $data ) ) {
1578 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1579 if ( !count( $data['user_groups'] ) ) {
1580 $this->mGroupMemberships
= [];
1582 $firstGroup = reset( $data['user_groups'] );
1583 if ( is_array( $firstGroup ) ||
is_object( $firstGroup ) ) {
1584 $this->mGroupMemberships
= [];
1585 foreach ( $data['user_groups'] as $row ) {
1586 $ugm = UserGroupMembership
::newFromRow( (object)$row );
1587 $this->mGroupMemberships
[$ugm->getGroup()] = $ugm;
1592 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1593 $this->loadOptions( $data['user_properties'] );
1599 * Load the data for this user object from another user object.
1603 protected function loadFromUserObject( $user ) {
1605 foreach ( self
::$mCacheVars as $var ) {
1606 $this->$var = $user->$var;
1611 * Load the groups from the database if they aren't already loaded.
1613 private function loadGroups() {
1614 if ( is_null( $this->mGroupMemberships
) ) {
1615 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1616 ?
wfGetDB( DB_MASTER
)
1617 : wfGetDB( DB_REPLICA
);
1618 $this->mGroupMemberships
= UserGroupMembership
::getMembershipsForUser(
1624 * Add the user to the group if he/she meets given criteria.
1626 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1627 * possible to remove manually via Special:UserRights. In such case it
1628 * will not be re-added automatically. The user will also not lose the
1629 * group if they no longer meet the criteria.
1631 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1633 * @return array Array of groups the user has been promoted to.
1635 * @see $wgAutopromoteOnce
1637 public function addAutopromoteOnceGroups( $event ) {
1638 global $wgAutopromoteOnceLogInRC;
1640 if ( wfReadOnly() ||
!$this->getId() ) {
1644 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1645 if ( !count( $toPromote ) ) {
1649 if ( !$this->checkAndSetTouched() ) {
1650 return []; // raced out (bug T48834)
1653 $oldGroups = $this->getGroups(); // previous groups
1654 $oldUGMs = $this->getGroupMemberships();
1655 foreach ( $toPromote as $group ) {
1656 $this->addGroup( $group );
1658 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1659 $newUGMs = $this->getGroupMemberships();
1661 // update groups in external authentication database
1662 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );
1663 AuthManager
::callLegacyAuthPlugin( 'updateExternalDBGroups', [ $this, $toPromote ] );
1665 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1666 $logEntry->setPerformer( $this );
1667 $logEntry->setTarget( $this->getUserPage() );
1668 $logEntry->setParameters( [
1669 '4::oldgroups' => $oldGroups,
1670 '5::newgroups' => $newGroups,
1672 $logid = $logEntry->insert();
1673 if ( $wgAutopromoteOnceLogInRC ) {
1674 $logEntry->publish( $logid );
1681 * Builds update conditions. Additional conditions may be added to $conditions to
1682 * protected against race conditions using a compare-and-set (CAS) mechanism
1683 * based on comparing $this->mTouched with the user_touched field.
1685 * @param Database $db
1686 * @param array $conditions WHERE conditions for use with Database::update
1687 * @return array WHERE conditions for use with Database::update
1689 protected function makeUpdateConditions( Database
$db, array $conditions ) {
1690 if ( $this->mTouched
) {
1691 // CAS check: only update if the row wasn't changed sicne it was loaded.
1692 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1699 * Bump user_touched if it didn't change since this object was loaded
1701 * On success, the mTouched field is updated.
1702 * The user serialization cache is always cleared.
1704 * @return bool Whether user_touched was actually updated
1707 protected function checkAndSetTouched() {
1710 if ( !$this->mId
) {
1711 return false; // anon
1714 // Get a new user_touched that is higher than the old one
1715 $newTouched = $this->newTouchedTimestamp();
1717 $dbw = wfGetDB( DB_MASTER
);
1718 $dbw->update( 'user',
1719 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1720 $this->makeUpdateConditions( $dbw, [
1721 'user_id' => $this->mId
,
1725 $success = ( $dbw->affectedRows() > 0 );
1728 $this->mTouched
= $newTouched;
1729 $this->clearSharedCache();
1731 // Clears on failure too since that is desired if the cache is stale
1732 $this->clearSharedCache( 'refresh' );
1739 * Clear various cached data stored in this object. The cache of the user table
1740 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1742 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1743 * given source. May be "name", "id", "actor", "defaults", "session", or false for no reload.
1745 public function clearInstanceCache( $reloadFrom = false ) {
1746 $this->mNewtalk
= -1;
1747 $this->mDatePreference
= null;
1748 $this->mBlockedby
= -1; # Unset
1749 $this->mHash
= false;
1750 $this->mRights
= null;
1751 $this->mEffectiveGroups
= null;
1752 $this->mImplicitGroups
= null;
1753 $this->mGroupMemberships
= null;
1754 $this->mOptions
= null;
1755 $this->mOptionsLoaded
= false;
1756 $this->mEditCount
= null;
1758 if ( $reloadFrom ) {
1759 $this->mLoadedItems
= [];
1760 $this->mFrom
= $reloadFrom;
1765 * Combine the language default options with any site-specific options
1766 * and add the default language variants.
1768 * @return array Array of String options
1770 public static function getDefaultOptions() {
1771 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgDefaultSkin;
1773 static $defOpt = null;
1774 static $defOptLang = null;
1776 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
1777 if ( $defOpt !== null && $defOptLang === $contLang->getCode() ) {
1778 // The content language does not change (and should not change) mid-request, but the
1779 // unit tests change it anyway, and expect this method to return values relevant to the
1780 // current content language.
1784 $defOpt = $wgDefaultUserOptions;
1785 // Default language setting
1786 $defOptLang = $contLang->getCode();
1787 $defOpt['language'] = $defOptLang;
1788 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1789 if ( $langCode === $contLang->getCode() ) {
1790 $defOpt['variant'] = $langCode;
1792 $defOpt["variant-$langCode"] = $langCode;
1796 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1797 // since extensions may change the set of searchable namespaces depending
1798 // on user groups/permissions.
1799 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1800 $defOpt['searchNs' . $nsnum] = (bool)$val;
1802 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1804 Hooks
::run( 'UserGetDefaultOptions', [ &$defOpt ] );
1810 * Get a given default option value.
1812 * @param string $opt Name of option to retrieve
1813 * @return string Default option value
1815 public static function getDefaultOption( $opt ) {
1816 $defOpts = self
::getDefaultOptions();
1817 if ( isset( $defOpts[$opt] ) ) {
1818 return $defOpts[$opt];
1825 * Get blocking information
1826 * @param bool $bFromSlave Whether to check the replica DB first.
1827 * To improve performance, non-critical checks are done against replica DBs.
1828 * Check when actually saving should be done against master.
1830 private function getBlockedStatus( $bFromSlave = true ) {
1831 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff, $wgSoftBlockRanges;
1833 if ( -1 != $this->mBlockedby
) {
1837 wfDebug( __METHOD__
. ": checking...\n" );
1839 // Initialize data...
1840 // Otherwise something ends up stomping on $this->mBlockedby when
1841 // things get lazy-loaded later, causing false positive block hits
1842 // due to -1 !== 0. Probably session-related... Nothing should be
1843 // overwriting mBlockedby, surely?
1846 # We only need to worry about passing the IP address to the Block generator if the
1847 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1848 # know which IP address they're actually coming from
1850 if ( !$this->isAllowed( 'ipblock-exempt' ) ) {
1851 // $wgUser->getName() only works after the end of Setup.php. Until
1852 // then, assume it's a logged-out user.
1853 $globalUserName = $wgUser->isSafeToLoad()
1854 ?
$wgUser->getName()
1855 : IP
::sanitizeIP( $wgUser->getRequest()->getIP() );
1856 if ( $this->getName() === $globalUserName ) {
1857 $ip = $this->getRequest()->getIP();
1862 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1865 if ( !$block instanceof Block
) {
1866 $block = $this->getBlockFromCookieValue( $this->getRequest()->getCookie( 'BlockID' ) );
1870 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1872 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1873 $block = new Block( [
1874 'byText' => wfMessage( 'proxyblocker' )->text(),
1875 'reason' => wfMessage( 'proxyblockreason' )->plain(),
1877 'systemBlock' => 'proxy',
1879 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1880 $block = new Block( [
1881 'byText' => wfMessage( 'sorbs' )->text(),
1882 'reason' => wfMessage( 'sorbsreason' )->plain(),
1884 'systemBlock' => 'dnsbl',
1889 // (T25343) Apply IP blocks to the contents of XFF headers, if enabled
1890 if ( !$block instanceof Block
1891 && $wgApplyIpBlocksToXff
1893 && !in_array( $ip, $wgProxyWhitelist )
1895 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1896 $xff = array_map( 'trim', explode( ',', $xff ) );
1897 $xff = array_diff( $xff, [ $ip ] );
1898 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1899 $block = Block
::chooseBlock( $xffblocks, $xff );
1900 if ( $block instanceof Block
) {
1901 # Mangle the reason to alert the user that the block
1902 # originated from matching the X-Forwarded-For header.
1903 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->plain();
1907 if ( !$block instanceof Block
1910 && IP
::isInRanges( $ip, $wgSoftBlockRanges )
1912 $block = new Block( [
1914 'byText' => 'MediaWiki default',
1915 'reason' => wfMessage( 'softblockrangesreason', $ip )->plain(),
1917 'systemBlock' => 'wgSoftBlockRanges',
1921 if ( $block instanceof Block
) {
1922 wfDebug( __METHOD__
. ": Found block.\n" );
1923 $this->mBlock
= $block;
1924 $this->mBlockedby
= $block->getByName();
1925 $this->mBlockreason
= $block->mReason
;
1926 $this->mHideName
= $block->mHideName
;
1927 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1929 $this->mBlock
= null;
1930 $this->mBlockedby
= '';
1931 $this->mBlockreason
= '';
1932 $this->mHideName
= 0;
1933 $this->mAllowUsertalk
= false;
1936 // Avoid PHP 7.1 warning of passing $this by reference
1939 Hooks
::run( 'GetBlockedStatus', [ &$user ] );
1943 * Try to load a Block from an ID given in a cookie value.
1944 * @param string|null $blockCookieVal The cookie value to check.
1945 * @return Block|bool The Block object, or false if none could be loaded.
1947 protected function getBlockFromCookieValue( $blockCookieVal ) {
1948 // Make sure there's something to check. The cookie value must start with a number.
1949 if ( strlen( $blockCookieVal ) < 1 ||
!is_numeric( substr( $blockCookieVal, 0, 1 ) ) ) {
1952 // Load the Block from the ID in the cookie.
1953 $blockCookieId = Block
::getIdFromCookieValue( $blockCookieVal );
1954 if ( $blockCookieId !== null ) {
1955 // An ID was found in the cookie.
1956 $tmpBlock = Block
::newFromID( $blockCookieId );
1957 if ( $tmpBlock instanceof Block
) {
1958 $config = RequestContext
::getMain()->getConfig();
1960 switch ( $tmpBlock->getType() ) {
1961 case Block
::TYPE_USER
:
1962 $blockIsValid = !$tmpBlock->isExpired() && $tmpBlock->isAutoblocking();
1963 $useBlockCookie = ( $config->get( 'CookieSetOnAutoblock' ) === true );
1965 case Block
::TYPE_IP
:
1966 case Block
::TYPE_RANGE
:
1967 // If block is type IP or IP range, load only if user is not logged in (T152462)
1968 $blockIsValid = !$tmpBlock->isExpired() && !$this->isLoggedIn();
1969 $useBlockCookie = ( $config->get( 'CookieSetOnIpBlock' ) === true );
1972 $blockIsValid = false;
1973 $useBlockCookie = false;
1976 if ( $blockIsValid && $useBlockCookie ) {
1980 // If the block is not valid, remove the cookie.
1981 Block
::clearCookie( $this->getRequest()->response() );
1984 // If the block doesn't exist, remove the cookie.
1985 Block
::clearCookie( $this->getRequest()->response() );
1992 * Whether the given IP is in a DNS blacklist.
1994 * @param string $ip IP to check
1995 * @param bool $checkWhitelist Whether to check the whitelist first
1996 * @return bool True if blacklisted.
1998 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1999 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
2001 if ( !$wgEnableDnsBlacklist ) {
2005 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
2009 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
2013 * Whether the given IP is in a given DNS blacklist.
2015 * @param string $ip IP to check
2016 * @param string|array $bases Array of Strings: URL of the DNS blacklist
2017 * @return bool True if blacklisted.
2019 public function inDnsBlacklist( $ip, $bases ) {
2021 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
2022 if ( IP
::isIPv4( $ip ) ) {
2023 // Reverse IP, T23255
2024 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
2026 foreach ( (array)$bases as $base ) {
2028 // If we have an access key, use that too (ProjectHoneypot, etc.)
2030 if ( is_array( $base ) ) {
2031 if ( count( $base ) >= 2 ) {
2032 // Access key is 1, base URL is 0
2033 $host = "{$base[1]}.$ipReversed.{$base[0]}";
2035 $host = "$ipReversed.{$base[0]}";
2037 $basename = $base[0];
2039 $host = "$ipReversed.$base";
2043 $ipList = gethostbynamel( $host );
2046 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
2050 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
2059 * Check if an IP address is in the local proxy list
2065 public static function isLocallyBlockedProxy( $ip ) {
2066 global $wgProxyList;
2068 if ( !$wgProxyList ) {
2072 if ( !is_array( $wgProxyList ) ) {
2073 // Load values from the specified file
2074 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
2077 $resultProxyList = [];
2078 $deprecatedIPEntries = [];
2080 // backward compatibility: move all ip addresses in keys to values
2081 foreach ( $wgProxyList as $key => $value ) {
2082 $keyIsIP = IP
::isIPAddress( $key );
2083 $valueIsIP = IP
::isIPAddress( $value );
2084 if ( $keyIsIP && !$valueIsIP ) {
2085 $deprecatedIPEntries[] = $key;
2086 $resultProxyList[] = $key;
2087 } elseif ( $keyIsIP && $valueIsIP ) {
2088 $deprecatedIPEntries[] = $key;
2089 $resultProxyList[] = $key;
2090 $resultProxyList[] = $value;
2092 $resultProxyList[] = $value;
2096 if ( $deprecatedIPEntries ) {
2098 'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
2099 implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
2102 $proxyListIPSet = new IPSet( $resultProxyList );
2103 return $proxyListIPSet->match( $ip );
2107 * Is this user subject to rate limiting?
2109 * @return bool True if rate limited
2111 public function isPingLimitable() {
2112 global $wgRateLimitsExcludedIPs;
2113 if ( IP
::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
2114 // No other good way currently to disable rate limits
2115 // for specific IPs. :P
2116 // But this is a crappy hack and should die.
2119 return !$this->isAllowed( 'noratelimit' );
2123 * Primitive rate limits: enforce maximum actions per time period
2124 * to put a brake on flooding.
2126 * The method generates both a generic profiling point and a per action one
2127 * (suffix being "-$action".
2129 * @note When using a shared cache like memcached, IP-address
2130 * last-hit counters will be shared across wikis.
2132 * @param string $action Action to enforce; 'edit' if unspecified
2133 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
2134 * @return bool True if a rate limiter was tripped
2136 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
2137 // Avoid PHP 7.1 warning of passing $this by reference
2139 // Call the 'PingLimiter' hook
2141 if ( !Hooks
::run( 'PingLimiter', [ &$user, $action, &$result, $incrBy ] ) ) {
2145 global $wgRateLimits;
2146 if ( !isset( $wgRateLimits[$action] ) ) {
2150 $limits = array_merge(
2151 [ '&can-bypass' => true ],
2152 $wgRateLimits[$action]
2155 // Some groups shouldn't trigger the ping limiter, ever
2156 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
2161 $id = $this->getId();
2163 $isNewbie = $this->isNewbie();
2164 $cache = ObjectCache
::getLocalClusterInstance();
2168 if ( isset( $limits['anon'] ) ) {
2169 $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
2172 // limits for logged-in users
2173 if ( isset( $limits['user'] ) ) {
2174 $userLimit = $limits['user'];
2178 // limits for anons and for newbie logged-in users
2181 if ( isset( $limits['ip'] ) ) {
2182 $ip = $this->getRequest()->getIP();
2183 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
2185 // subnet-based limits
2186 if ( isset( $limits['subnet'] ) ) {
2187 $ip = $this->getRequest()->getIP();
2188 $subnet = IP
::getSubnet( $ip );
2189 if ( $subnet !== false ) {
2190 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
2195 // Check for group-specific permissions
2196 // If more than one group applies, use the group with the highest limit ratio (max/period)
2197 foreach ( $this->getGroups() as $group ) {
2198 if ( isset( $limits[$group] ) ) {
2199 if ( $userLimit === false
2200 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
2202 $userLimit = $limits[$group];
2207 // limits for newbie logged-in users (override all the normal user limits)
2208 if ( $id !== 0 && $isNewbie && isset( $limits['newbie'] ) ) {
2209 $userLimit = $limits['newbie'];
2212 // Set the user limit key
2213 if ( $userLimit !== false ) {
2214 list( $max, $period ) = $userLimit;
2215 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
2216 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
2219 // ip-based limits for all ping-limitable users
2220 if ( isset( $limits['ip-all'] ) ) {
2221 $ip = $this->getRequest()->getIP();
2222 // ignore if user limit is more permissive
2223 if ( $isNewbie ||
$userLimit === false
2224 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
2225 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
2229 // subnet-based limits for all ping-limitable users
2230 if ( isset( $limits['subnet-all'] ) ) {
2231 $ip = $this->getRequest()->getIP();
2232 $subnet = IP
::getSubnet( $ip );
2233 if ( $subnet !== false ) {
2234 // ignore if user limit is more permissive
2235 if ( $isNewbie ||
$userLimit === false
2236 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
2237 > $userLimit[0] / $userLimit[1] ) {
2238 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
2244 foreach ( $keys as $key => $limit ) {
2245 list( $max, $period ) = $limit;
2246 $summary = "(limit $max in {$period}s)";
2247 $count = $cache->get( $key );
2250 if ( $count >= $max ) {
2251 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
2252 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
2255 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
2258 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
2259 if ( $incrBy > 0 ) {
2260 $cache->add( $key, 0, intval( $period ) ); // first ping
2263 if ( $incrBy > 0 ) {
2264 $cache->incr( $key, $incrBy );
2272 * Check if user is blocked
2274 * @param bool $bFromSlave Whether to check the replica DB instead of
2275 * the master. Hacked from false due to horrible probs on site.
2276 * @return bool True if blocked, false otherwise
2278 public function isBlocked( $bFromSlave = true ) {
2279 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
2283 * Get the block affecting the user, or null if the user is not blocked
2285 * @param bool $bFromSlave Whether to check the replica DB instead of the master
2286 * @return Block|null
2288 public function getBlock( $bFromSlave = true ) {
2289 $this->getBlockedStatus( $bFromSlave );
2290 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
2294 * Check if user is blocked from editing a particular article
2296 * @param Title $title Title to check
2297 * @param bool $bFromSlave Whether to check the replica DB instead of the master
2300 public function isBlockedFrom( $title, $bFromSlave = false ) {
2301 global $wgBlockAllowsUTEdit;
2303 $blocked = $this->isBlocked( $bFromSlave );
2304 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
2305 // If a user's name is suppressed, they cannot make edits anywhere
2306 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName()
2307 && $title->getNamespace() == NS_USER_TALK
) {
2309 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
2312 Hooks
::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
2318 * If user is blocked, return the name of the user who placed the block
2319 * @return string Name of blocker
2321 public function blockedBy() {
2322 $this->getBlockedStatus();
2323 return $this->mBlockedby
;
2327 * If user is blocked, return the specified reason for the block
2328 * @return string Blocking reason
2330 public function blockedFor() {
2331 $this->getBlockedStatus();
2332 return $this->mBlockreason
;
2336 * If user is blocked, return the ID for the block
2337 * @return int Block ID
2339 public function getBlockId() {
2340 $this->getBlockedStatus();
2341 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2345 * Check if user is blocked on all wikis.
2346 * Do not use for actual edit permission checks!
2347 * This is intended for quick UI checks.
2349 * @param string $ip IP address, uses current client if none given
2350 * @return bool True if blocked, false otherwise
2352 public function isBlockedGlobally( $ip = '' ) {
2353 return $this->getGlobalBlock( $ip ) instanceof Block
;
2357 * Check if user is blocked on all wikis.
2358 * Do not use for actual edit permission checks!
2359 * This is intended for quick UI checks.
2361 * @param string $ip IP address, uses current client if none given
2362 * @return Block|null Block object if blocked, null otherwise
2363 * @throws FatalError
2364 * @throws MWException
2366 public function getGlobalBlock( $ip = '' ) {
2367 if ( $this->mGlobalBlock
!== null ) {
2368 return $this->mGlobalBlock ?
: null;
2370 // User is already an IP?
2371 if ( IP
::isIPAddress( $this->getName() ) ) {
2372 $ip = $this->getName();
2374 $ip = $this->getRequest()->getIP();
2376 // Avoid PHP 7.1 warning of passing $this by reference
2380 Hooks
::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
2382 if ( $blocked && $block === null ) {
2383 // back-compat: UserIsBlockedGlobally didn't have $block param first
2384 $block = new Block( [
2386 'systemBlock' => 'global-block'
2390 $this->mGlobalBlock
= $blocked ?
$block : false;
2391 return $this->mGlobalBlock ?
: null;
2395 * Check if user account is locked
2397 * @return bool True if locked, false otherwise
2399 public function isLocked() {
2400 if ( $this->mLocked
!== null ) {
2401 return $this->mLocked
;
2403 // Avoid PHP 7.1 warning of passing $this by reference
2405 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$user ], null );
2406 $this->mLocked
= $authUser && $authUser->isLocked();
2407 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2408 return $this->mLocked
;
2412 * Check if user account is hidden
2414 * @return bool True if hidden, false otherwise
2416 public function isHidden() {
2417 if ( $this->mHideName
!== null ) {
2418 return $this->mHideName
;
2420 $this->getBlockedStatus();
2421 if ( !$this->mHideName
) {
2422 // Avoid PHP 7.1 warning of passing $this by reference
2424 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$user ], null );
2425 $this->mHideName
= $authUser && $authUser->isHidden();
2426 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2428 return $this->mHideName
;
2432 * Get the user's ID.
2433 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2435 public function getId() {
2436 if ( $this->mId
=== null && $this->mName
!== null && self
::isIP( $this->mName
) ) {
2437 // Special case, we know the user is anonymous
2439 } elseif ( !$this->isItemLoaded( 'id' ) ) {
2440 // Don't load if this was initialized from an ID
2444 return (int)$this->mId
;
2448 * Set the user and reload all fields according to a given ID
2449 * @param int $v User ID to reload
2451 public function setId( $v ) {
2453 $this->clearInstanceCache( 'id' );
2457 * Get the user name, or the IP of an anonymous user
2458 * @return string User's name or IP address
2460 public function getName() {
2461 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2462 // Special case optimisation
2463 return $this->mName
;
2466 if ( $this->mName
=== false ) {
2468 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2470 return $this->mName
;
2475 * Set the user name.
2477 * This does not reload fields from the database according to the given
2478 * name. Rather, it is used to create a temporary "nonexistent user" for
2479 * later addition to the database. It can also be used to set the IP
2480 * address for an anonymous user to something other than the current
2483 * @note User::newFromName() has roughly the same function, when the named user
2485 * @param string $str New user name to set
2487 public function setName( $str ) {
2489 $this->mName
= $str;
2493 * Get the user's actor ID.
2495 * @param IDatabase|null $dbw Assign a new actor ID, using this DB handle, if none exists
2496 * @return int The actor's ID, or 0 if no actor ID exists and $dbw was null
2498 public function getActorId( IDatabase
$dbw = null ) {
2499 global $wgActorTableSchemaMigrationStage;
2501 // Technically we should always return 0 without SCHEMA_COMPAT_READ_NEW,
2502 // but it does little harm and might be needed for write callers loading a User.
2503 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) ) {
2507 if ( !$this->isItemLoaded( 'actor' ) ) {
2511 // Currently $this->mActorId might be null if $this was loaded from a
2512 // cache entry that was written when $wgActorTableSchemaMigrationStage
2513 // was SCHEMA_COMPAT_OLD. Once that is no longer a possibility (i.e. when
2514 // User::VERSION is incremented after $wgActorTableSchemaMigrationStage
2515 // has been removed), that condition may be removed.
2516 if ( $this->mActorId
=== null ||
!$this->mActorId
&& $dbw ) {
2518 'actor_user' => $this->getId() ?
: null,
2519 'actor_name' => (string)$this->getName(),
2522 if ( $q['actor_user'] === null && self
::isUsableName( $q['actor_name'] ) ) {
2523 throw new CannotCreateActorException(
2524 'Cannot create an actor for a usable name that is not an existing user'
2527 if ( $q['actor_name'] === '' ) {
2528 throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
2530 $dbw->insert( 'actor', $q, __METHOD__
, [ 'IGNORE' ] );
2531 if ( $dbw->affectedRows() ) {
2532 $this->mActorId
= (int)$dbw->insertId();
2535 list( , $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2536 $this->mActorId
= (int)$dbw->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2537 if ( !$this->mActorId
) {
2538 throw new CannotCreateActorException(
2539 "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
2543 $this->invalidateCache();
2545 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2546 $db = wfGetDB( $index );
2547 $this->mActorId
= (int)$db->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2549 $this->setItemLoaded( 'actor' );
2552 return (int)$this->mActorId
;
2556 * Get the user's name escaped by underscores.
2557 * @return string Username escaped by underscores.
2559 public function getTitleKey() {
2560 return str_replace( ' ', '_', $this->getName() );
2564 * Check if the user has new messages.
2565 * @return bool True if the user has new messages
2567 public function getNewtalk() {
2570 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2571 if ( $this->mNewtalk
=== -1 ) {
2572 $this->mNewtalk
= false; # reset talk page status
2574 // Check memcached separately for anons, who have no
2575 // entire User object stored in there.
2576 if ( !$this->mId
) {
2577 global $wgDisableAnonTalk;
2578 if ( $wgDisableAnonTalk ) {
2579 // Anon newtalk disabled by configuration.
2580 $this->mNewtalk
= false;
2582 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2585 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2589 return (bool)$this->mNewtalk
;
2593 * Return the data needed to construct links for new talk page message
2594 * alerts. If there are new messages, this will return an associative array
2595 * with the following data:
2596 * wiki: The database name of the wiki
2597 * link: Root-relative link to the user's talk page
2598 * rev: The last talk page revision that the user has seen or null. This
2599 * is useful for building diff links.
2600 * If there are no new messages, it returns an empty array.
2601 * @note This function was designed to accomodate multiple talk pages, but
2602 * currently only returns a single link and revision.
2605 public function getNewMessageLinks() {
2606 // Avoid PHP 7.1 warning of passing $this by reference
2609 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
2611 } elseif ( !$this->getNewtalk() ) {
2614 $utp = $this->getTalkPage();
2615 $dbr = wfGetDB( DB_REPLICA
);
2616 // Get the "last viewed rev" timestamp from the oldest message notification
2617 $timestamp = $dbr->selectField( 'user_newtalk',
2618 'MIN(user_last_timestamp)',
2619 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2621 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2622 return [ [ 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ] ];
2626 * Get the revision ID for the last talk page revision viewed by the talk
2628 * @return int|null Revision ID or null
2630 public function getNewMessageRevisionId() {
2631 $newMessageRevisionId = null;
2632 $newMessageLinks = $this->getNewMessageLinks();
2633 if ( $newMessageLinks ) {
2634 // Note: getNewMessageLinks() never returns more than a single link
2635 // and it is always for the same wiki, but we double-check here in
2636 // case that changes some time in the future.
2637 if ( count( $newMessageLinks ) === 1
2638 && $newMessageLinks[0]['wiki'] === wfWikiID()
2639 && $newMessageLinks[0]['rev']
2641 /** @var Revision $newMessageRevision */
2642 $newMessageRevision = $newMessageLinks[0]['rev'];
2643 $newMessageRevisionId = $newMessageRevision->getId();
2646 return $newMessageRevisionId;
2650 * Internal uncached check for new messages
2653 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2654 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2655 * @return bool True if the user has new messages
2657 protected function checkNewtalk( $field, $id ) {
2658 $dbr = wfGetDB( DB_REPLICA
);
2660 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2662 return $ok !== false;
2666 * Add or update the new messages flag
2667 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2668 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2669 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2670 * @return bool True if successful, false otherwise
2672 protected function updateNewtalk( $field, $id, $curRev = null ) {
2673 // Get timestamp of the talk page revision prior to the current one
2674 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2675 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2676 // Mark the user as having new messages since this revision
2677 $dbw = wfGetDB( DB_MASTER
);
2678 $dbw->insert( 'user_newtalk',
2679 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2682 if ( $dbw->affectedRows() ) {
2683 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2686 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2692 * Clear the new messages flag for the given user
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 * @return bool True if successful, false otherwise
2697 protected function deleteNewtalk( $field, $id ) {
2698 $dbw = wfGetDB( DB_MASTER
);
2699 $dbw->delete( 'user_newtalk',
2702 if ( $dbw->affectedRows() ) {
2703 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2706 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2712 * Update the 'You have new messages!' status.
2713 * @param bool $val Whether the user has new messages
2714 * @param Revision|null $curRev New, as yet unseen revision of the user talk
2715 * page. Ignored if null or !$val.
2717 public function setNewtalk( $val, $curRev = null ) {
2718 if ( wfReadOnly() ) {
2723 $this->mNewtalk
= $val;
2725 if ( $this->isAnon() ) {
2727 $id = $this->getName();
2730 $id = $this->getId();
2734 $changed = $this->updateNewtalk( $field, $id, $curRev );
2736 $changed = $this->deleteNewtalk( $field, $id );
2740 $this->invalidateCache();
2745 * Generate a current or new-future timestamp to be stored in the
2746 * user_touched field when we update things.
2747 * @return string Timestamp in TS_MW format
2749 private function newTouchedTimestamp() {
2750 global $wgClockSkewFudge;
2752 $time = wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2753 if ( $this->mTouched
&& $time <= $this->mTouched
) {
2754 $time = wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2761 * Clear user data from memcached
2763 * Use after applying updates to the database; caller's
2764 * responsibility to update user_touched if appropriate.
2766 * Called implicitly from invalidateCache() and saveSettings().
2768 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2770 public function clearSharedCache( $mode = 'changed' ) {
2771 if ( !$this->getId() ) {
2775 $cache = ObjectCache
::getMainWANInstance();
2776 $key = $this->getCacheKey( $cache );
2777 if ( $mode === 'refresh' ) {
2778 $cache->delete( $key, 1 );
2780 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2781 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2782 $lb->getConnection( DB_MASTER
)->onTransactionPreCommitOrIdle(
2783 function () use ( $cache, $key ) {
2784 $cache->delete( $key );
2789 $cache->delete( $key );
2795 * Immediately touch the user data cache for this account
2797 * Calls touch() and removes account data from memcached
2799 public function invalidateCache() {
2801 $this->clearSharedCache();
2805 * Update the "touched" timestamp for the user
2807 * This is useful on various login/logout events when making sure that
2808 * a browser or proxy that has multiple tenants does not suffer cache
2809 * pollution where the new user sees the old users content. The value
2810 * of getTouched() is checked when determining 304 vs 200 responses.
2811 * Unlike invalidateCache(), this preserves the User object cache and
2812 * avoids database writes.
2816 public function touch() {
2817 $id = $this->getId();
2819 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2820 $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
2821 $cache->touchCheckKey( $key );
2822 $this->mQuickTouched
= null;
2827 * Validate the cache for this account.
2828 * @param string $timestamp A timestamp in TS_MW format
2831 public function validateCache( $timestamp ) {
2832 return ( $timestamp >= $this->getTouched() );
2836 * Get the user touched timestamp
2838 * Use this value only to validate caches via inequalities
2839 * such as in the case of HTTP If-Modified-Since response logic
2841 * @return string TS_MW Timestamp
2843 public function getTouched() {
2847 if ( $this->mQuickTouched
=== null ) {
2848 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2849 $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId
);
2851 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2854 return max( $this->mTouched
, $this->mQuickTouched
);
2857 return $this->mTouched
;
2861 * Get the user_touched timestamp field (time of last DB updates)
2862 * @return string TS_MW Timestamp
2865 public function getDBTouched() {
2868 return $this->mTouched
;
2872 * Set the password and reset the random token.
2873 * Calls through to authentication plugin if necessary;
2874 * will have no effect if the auth plugin refuses to
2875 * pass the change through or if the legal password
2878 * As a special case, setting the password to null
2879 * wipes it, so the account cannot be logged in until
2880 * a new password is set, for instance via e-mail.
2882 * @deprecated since 1.27, use AuthManager instead
2883 * @param string $str New password to set
2884 * @throws PasswordError On failure
2887 public function setPassword( $str ) {
2888 wfDeprecated( __METHOD__
, '1.27' );
2889 return $this->setPasswordInternal( $str );
2893 * Set the password and reset the random token unconditionally.
2895 * @deprecated since 1.27, use AuthManager instead
2896 * @param string|null $str New password to set or null to set an invalid
2897 * password hash meaning that the user will not be able to log in
2898 * through the web interface.
2900 public function setInternalPassword( $str ) {
2901 wfDeprecated( __METHOD__
, '1.27' );
2902 $this->setPasswordInternal( $str );
2906 * Actually set the password and such
2907 * @since 1.27 cannot set a password for a user not in the database
2908 * @param string|null $str New password to set or null to set an invalid
2909 * password hash meaning that the user will not be able to log in
2910 * through the web interface.
2911 * @return bool Success
2913 private function setPasswordInternal( $str ) {
2914 $manager = AuthManager
::singleton();
2916 // If the user doesn't exist yet, fail
2917 if ( !$manager->userExists( $this->getName() ) ) {
2918 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2921 $status = $this->changeAuthenticationData( [
2922 'username' => $this->getName(),
2926 if ( !$status->isGood() ) {
2927 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2928 ->info( __METHOD__
. ': Password change rejected: '
2929 . $status->getWikiText( null, null, 'en' ) );
2933 $this->setOption( 'watchlisttoken', false );
2934 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2940 * Changes credentials of the user.
2942 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2943 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2944 * e.g. when no provider handled the change.
2946 * @param array $data A set of authentication data in fieldname => value format. This is the
2947 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2951 public function changeAuthenticationData( array $data ) {
2952 $manager = AuthManager
::singleton();
2953 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2954 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2956 $status = Status
::newGood( 'ignored' );
2957 foreach ( $reqs as $req ) {
2958 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2960 if ( $status->getValue() === 'ignored' ) {
2961 $status->warning( 'authenticationdatachange-ignored' );
2964 if ( $status->isGood() ) {
2965 foreach ( $reqs as $req ) {
2966 $manager->changeAuthenticationData( $req );
2973 * Get the user's current token.
2974 * @param bool $forceCreation Force the generation of a new token if the
2975 * user doesn't have one (default=true for backwards compatibility).
2976 * @return string|null Token
2978 public function getToken( $forceCreation = true ) {
2979 global $wgAuthenticationTokenVersion;
2982 if ( !$this->mToken
&& $forceCreation ) {
2986 if ( !$this->mToken
) {
2987 // The user doesn't have a token, return null to indicate that.
2989 } elseif ( $this->mToken
=== self
::INVALID_TOKEN
) {
2990 // We return a random value here so existing token checks are very
2992 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2993 } elseif ( $wgAuthenticationTokenVersion === null ) {
2994 // $wgAuthenticationTokenVersion not in use, so return the raw secret
2995 return $this->mToken
;
2997 // $wgAuthenticationTokenVersion in use, so hmac it.
2998 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
3000 // The raw hash can be overly long. Shorten it up.
3001 $len = max( 32, self
::TOKEN_LENGTH
);
3002 if ( strlen( $ret ) < $len ) {
3003 // Should never happen, even md5 is 128 bits
3004 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
3006 return substr( $ret, -$len );
3011 * Set the random token (used for persistent authentication)
3012 * Called from loadDefaults() among other places.
3014 * @param string|bool $token If specified, set the token to this value
3016 public function setToken( $token = false ) {
3018 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
3019 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3020 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
3021 } elseif ( !$token ) {
3022 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3024 $this->mToken
= $token;
3029 * Set the password for a password reminder or new account email
3031 * @deprecated Removed in 1.27. Use PasswordReset instead.
3032 * @param string $str New password to set or null to set an invalid
3033 * password hash meaning that the user will not be able to use it
3034 * @param bool $throttle If true, reset the throttle timestamp to the present
3036 public function setNewpassword( $str, $throttle = true ) {
3037 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
3041 * Get the user's e-mail address
3042 * @return string User's email address
3044 public function getEmail() {
3046 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
3047 return $this->mEmail
;
3051 * Get the timestamp of the user's e-mail authentication
3052 * @return string TS_MW timestamp
3054 public function getEmailAuthenticationTimestamp() {
3056 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
3057 return $this->mEmailAuthenticated
;
3061 * Set the user's e-mail address
3062 * @param string $str New e-mail address
3064 public function setEmail( $str ) {
3066 if ( $str == $this->mEmail
) {
3069 $this->invalidateEmail();
3070 $this->mEmail
= $str;
3071 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
3075 * Set the user's e-mail address and a confirmation mail if needed.
3078 * @param string $str New e-mail address
3081 public function setEmailWithConfirmation( $str ) {
3082 global $wgEnableEmail, $wgEmailAuthentication;
3084 if ( !$wgEnableEmail ) {
3085 return Status
::newFatal( 'emaildisabled' );
3088 $oldaddr = $this->getEmail();
3089 if ( $str === $oldaddr ) {
3090 return Status
::newGood( true );
3093 $type = $oldaddr != '' ?
'changed' : 'set';
3094 $notificationResult = null;
3096 if ( $wgEmailAuthentication ) {
3097 // Send the user an email notifying the user of the change in registered
3098 // email address on their previous email address
3099 if ( $type == 'changed' ) {
3100 $change = $str != '' ?
'changed' : 'removed';
3101 $notificationResult = $this->sendMail(
3102 wfMessage( 'notificationemail_subject_' . $change )->text(),
3103 wfMessage( 'notificationemail_body_' . $change,
3104 $this->getRequest()->getIP(),
3111 $this->setEmail( $str );
3113 if ( $str !== '' && $wgEmailAuthentication ) {
3114 // Send a confirmation request to the new address if needed
3115 $result = $this->sendConfirmationMail( $type );
3117 if ( $notificationResult !== null ) {
3118 $result->merge( $notificationResult );
3121 if ( $result->isGood() ) {
3122 // Say to the caller that a confirmation and notification mail has been sent
3123 $result->value
= 'eauth';
3126 $result = Status
::newGood( true );
3133 * Get the user's real name
3134 * @return string User's real name
3136 public function getRealName() {
3137 if ( !$this->isItemLoaded( 'realname' ) ) {
3141 return $this->mRealName
;
3145 * Set the user's real name
3146 * @param string $str New real name
3148 public function setRealName( $str ) {
3150 $this->mRealName
= $str;
3154 * Get the user's current setting for a given option.
3156 * @param string $oname The option to check
3157 * @param string|array|null $defaultOverride A default value returned if the option does not exist
3158 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
3159 * @return string|array|int|null User's current value for the option
3160 * @see getBoolOption()
3161 * @see getIntOption()
3163 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
3164 global $wgHiddenPrefs;
3165 $this->loadOptions();
3167 # We want 'disabled' preferences to always behave as the default value for
3168 # users, even if they have set the option explicitly in their settings (ie they
3169 # set it, and then it was disabled removing their ability to change it). But
3170 # we don't want to erase the preferences in the database in case the preference
3171 # is re-enabled again. So don't touch $mOptions, just override the returned value
3172 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
3173 return self
::getDefaultOption( $oname );
3176 if ( array_key_exists( $oname, $this->mOptions
) ) {
3177 return $this->mOptions
[$oname];
3179 return $defaultOverride;
3184 * Get all user's options
3186 * @param int $flags Bitwise combination of:
3187 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
3188 * to the default value. (Since 1.25)
3191 public function getOptions( $flags = 0 ) {
3192 global $wgHiddenPrefs;
3193 $this->loadOptions();
3194 $options = $this->mOptions
;
3196 # We want 'disabled' preferences to always behave as the default value for
3197 # users, even if they have set the option explicitly in their settings (ie they
3198 # set it, and then it was disabled removing their ability to change it). But
3199 # we don't want to erase the preferences in the database in case the preference
3200 # is re-enabled again. So don't touch $mOptions, just override the returned value
3201 foreach ( $wgHiddenPrefs as $pref ) {
3202 $default = self
::getDefaultOption( $pref );
3203 if ( $default !== null ) {
3204 $options[$pref] = $default;
3208 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
3209 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
3216 * Get the user's current setting for a given option, as a boolean value.
3218 * @param string $oname The option to check
3219 * @return bool User's current value for the option
3222 public function getBoolOption( $oname ) {
3223 return (bool)$this->getOption( $oname );
3227 * Get the user's current setting for a given option, as an integer value.
3229 * @param string $oname The option to check
3230 * @param int $defaultOverride A default value returned if the option does not exist
3231 * @return int User's current value for the option
3234 public function getIntOption( $oname, $defaultOverride = 0 ) {
3235 $val = $this->getOption( $oname );
3237 $val = $defaultOverride;
3239 return intval( $val );
3243 * Set the given option for a user.
3245 * You need to call saveSettings() to actually write to the database.
3247 * @param string $oname The option to set
3248 * @param mixed $val New value to set
3250 public function setOption( $oname, $val ) {
3251 $this->loadOptions();
3253 // Explicitly NULL values should refer to defaults
3254 if ( is_null( $val ) ) {
3255 $val = self
::getDefaultOption( $oname );
3258 $this->mOptions
[$oname] = $val;
3262 * Get a token stored in the preferences (like the watchlist one),
3263 * resetting it if it's empty (and saving changes).
3265 * @param string $oname The option name to retrieve the token from
3266 * @return string|bool User's current value for the option, or false if this option is disabled.
3267 * @see resetTokenFromOption()
3269 * @deprecated since 1.26 Applications should use the OAuth extension
3271 public function getTokenFromOption( $oname ) {
3272 global $wgHiddenPrefs;
3274 $id = $this->getId();
3275 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
3279 $token = $this->getOption( $oname );
3281 // Default to a value based on the user token to avoid space
3282 // wasted on storing tokens for all users. When this option
3283 // is set manually by the user, only then is it stored.
3284 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
3291 * Reset a token stored in the preferences (like the watchlist one).
3292 * *Does not* save user's preferences (similarly to setOption()).
3294 * @param string $oname The option name to reset the token in
3295 * @return string|bool New token value, or false if this option is disabled.
3296 * @see getTokenFromOption()
3299 public function resetTokenFromOption( $oname ) {
3300 global $wgHiddenPrefs;
3301 if ( in_array( $oname, $wgHiddenPrefs ) ) {
3305 $token = MWCryptRand
::generateHex( 40 );
3306 $this->setOption( $oname, $token );
3311 * Return a list of the types of user options currently returned by
3312 * User::getOptionKinds().
3314 * Currently, the option kinds are:
3315 * - 'registered' - preferences which are registered in core MediaWiki or
3316 * by extensions using the UserGetDefaultOptions hook.
3317 * - 'registered-multiselect' - as above, using the 'multiselect' type.
3318 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
3319 * - 'userjs' - preferences with names starting with 'userjs-', intended to
3320 * be used by user scripts.
3321 * - 'special' - "preferences" that are not accessible via User::getOptions
3322 * or User::setOptions.
3323 * - 'unused' - preferences about which MediaWiki doesn't know anything.
3324 * These are usually legacy options, removed in newer versions.
3326 * The API (and possibly others) use this function to determine the possible
3327 * option types for validation purposes, so make sure to update this when a
3328 * new option kind is added.
3330 * @see User::getOptionKinds
3331 * @return array Option kinds
3333 public static function listOptionKinds() {
3336 'registered-multiselect',
3337 'registered-checkmatrix',
3345 * Return an associative array mapping preferences keys to the kind of a preference they're
3346 * used for. Different kinds are handled differently when setting or reading preferences.
3348 * See User::listOptionKinds for the list of valid option types that can be provided.
3350 * @see User::listOptionKinds
3351 * @param IContextSource $context
3352 * @param array|null $options Assoc. array with options keys to check as keys.
3353 * Defaults to $this->mOptions.
3354 * @return array The key => kind mapping data
3356 public function getOptionKinds( IContextSource
$context, $options = null ) {
3357 $this->loadOptions();
3358 if ( $options === null ) {
3359 $options = $this->mOptions
;
3362 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
3363 $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
3366 // Pull out the "special" options, so they don't get converted as
3367 // multiselect or checkmatrix.
3368 $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
3369 foreach ( $specialOptions as $name => $value ) {
3370 unset( $prefs[$name] );
3373 // Multiselect and checkmatrix options are stored in the database with
3374 // one key per option, each having a boolean value. Extract those keys.
3375 $multiselectOptions = [];
3376 foreach ( $prefs as $name => $info ) {
3377 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3378 ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField
::class ) ) {
3379 $opts = HTMLFormField
::flattenOptions( $info['options'] );
3380 $prefix = $info['prefix'] ??
$name;
3382 foreach ( $opts as $value ) {
3383 $multiselectOptions["$prefix$value"] = true;
3386 unset( $prefs[$name] );
3389 $checkmatrixOptions = [];
3390 foreach ( $prefs as $name => $info ) {
3391 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3392 ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix
::class ) ) {
3393 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3394 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3395 $prefix = $info['prefix'] ??
$name;
3397 foreach ( $columns as $column ) {
3398 foreach ( $rows as $row ) {
3399 $checkmatrixOptions["$prefix$column-$row"] = true;
3403 unset( $prefs[$name] );
3407 // $value is ignored
3408 foreach ( $options as $key => $value ) {
3409 if ( isset( $prefs[$key] ) ) {
3410 $mapping[$key] = 'registered';
3411 } elseif ( isset( $multiselectOptions[$key] ) ) {
3412 $mapping[$key] = 'registered-multiselect';
3413 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3414 $mapping[$key] = 'registered-checkmatrix';
3415 } elseif ( isset( $specialOptions[$key] ) ) {
3416 $mapping[$key] = 'special';
3417 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3418 $mapping[$key] = 'userjs';
3420 $mapping[$key] = 'unused';
3428 * Reset certain (or all) options to the site defaults
3430 * The optional parameter determines which kinds of preferences will be reset.
3431 * Supported values are everything that can be reported by getOptionKinds()
3432 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3434 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3435 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3436 * for backwards-compatibility.
3437 * @param IContextSource|null $context Context source used when $resetKinds
3438 * does not contain 'all', passed to getOptionKinds().
3439 * Defaults to RequestContext::getMain() when null.
3441 public function resetOptions(
3442 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3443 IContextSource
$context = null
3446 $defaultOptions = self
::getDefaultOptions();
3448 if ( !is_array( $resetKinds ) ) {
3449 $resetKinds = [ $resetKinds ];
3452 if ( in_array( 'all', $resetKinds ) ) {
3453 $newOptions = $defaultOptions;
3455 if ( $context === null ) {
3456 $context = RequestContext
::getMain();
3459 $optionKinds = $this->getOptionKinds( $context );
3460 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3463 // Use default values for the options that should be deleted, and
3464 // copy old values for the ones that shouldn't.
3465 foreach ( $this->mOptions
as $key => $value ) {
3466 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3467 if ( array_key_exists( $key, $defaultOptions ) ) {
3468 $newOptions[$key] = $defaultOptions[$key];
3471 $newOptions[$key] = $value;
3476 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3478 $this->mOptions
= $newOptions;
3479 $this->mOptionsLoaded
= true;
3483 * Get the user's preferred date format.
3484 * @return string User's preferred date format
3486 public function getDatePreference() {
3487 // Important migration for old data rows
3488 if ( is_null( $this->mDatePreference
) ) {
3490 $value = $this->getOption( 'date' );
3491 $map = $wgLang->getDatePreferenceMigrationMap();
3492 if ( isset( $map[$value] ) ) {
3493 $value = $map[$value];
3495 $this->mDatePreference
= $value;
3497 return $this->mDatePreference
;
3501 * Determine based on the wiki configuration and the user's options,
3502 * whether this user must be over HTTPS no matter what.
3506 public function requiresHTTPS() {
3507 global $wgSecureLogin;
3508 if ( !$wgSecureLogin ) {
3511 $https = $this->getBoolOption( 'prefershttps' );
3512 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3514 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3521 * Get the user preferred stub threshold
3525 public function getStubThreshold() {
3526 global $wgMaxArticleSize; # Maximum article size, in Kb
3527 $threshold = $this->getIntOption( 'stubthreshold' );
3528 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3529 // If they have set an impossible value, disable the preference
3530 // so we can use the parser cache again.
3537 * Get the permissions this user has.
3538 * @return string[] permission names
3540 public function getRights() {
3541 if ( is_null( $this->mRights
) ) {
3542 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3543 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3545 // Deny any rights denied by the user's session, unless this
3546 // endpoint has no sessions.
3547 if ( !defined( 'MW_NO_SESSION' ) ) {
3548 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3549 if ( $allowedRights !== null ) {
3550 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3554 Hooks
::run( 'UserGetRightsRemove', [ $this, &$this->mRights
] );
3555 // Force reindexation of rights when a hook has unset one of them
3556 $this->mRights
= array_values( array_unique( $this->mRights
) );
3558 // If block disables login, we should also remove any
3559 // extra rights blocked users might have, in case the
3560 // blocked user has a pre-existing session (T129738).
3561 // This is checked here for cases where people only call
3562 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3563 // to give a better error message in the common case.
3564 $config = RequestContext
::getMain()->getConfig();
3566 $this->isLoggedIn() &&
3567 $config->get( 'BlockDisablesLogin' ) &&
3571 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3574 return $this->mRights
;
3578 * Get the list of explicit group memberships this user has.
3579 * The implicit * and user groups are not included.
3580 * @return array Array of String internal group names
3582 public function getGroups() {
3584 $this->loadGroups();
3585 return array_keys( $this->mGroupMemberships
);
3589 * Get the list of explicit group memberships this user has, stored as
3590 * UserGroupMembership objects. Implicit groups are not included.
3592 * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
3595 public function getGroupMemberships() {
3597 $this->loadGroups();
3598 return $this->mGroupMemberships
;
3602 * Get the list of implicit group memberships this user has.
3603 * This includes all explicit groups, plus 'user' if logged in,
3604 * '*' for all accounts, and autopromoted groups
3605 * @param bool $recache Whether to avoid the cache
3606 * @return array Array of String internal group names
3608 public function getEffectiveGroups( $recache = false ) {
3609 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3610 $this->mEffectiveGroups
= array_unique( array_merge(
3611 $this->getGroups(), // explicit groups
3612 $this->getAutomaticGroups( $recache ) // implicit groups
3614 // Avoid PHP 7.1 warning of passing $this by reference
3616 // Hook for additional groups
3617 Hooks
::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups
] );
3618 // Force reindexation of groups when a hook has unset one of them
3619 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3621 return $this->mEffectiveGroups
;
3625 * Get the list of implicit group memberships this user has.
3626 * This includes 'user' if logged in, '*' for all accounts,
3627 * and autopromoted groups
3628 * @param bool $recache Whether to avoid the cache
3629 * @return array Array of String internal group names
3631 public function getAutomaticGroups( $recache = false ) {
3632 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3633 $this->mImplicitGroups
= [ '*' ];
3634 if ( $this->getId() ) {
3635 $this->mImplicitGroups
[] = 'user';
3637 $this->mImplicitGroups
= array_unique( array_merge(
3638 $this->mImplicitGroups
,
3639 Autopromote
::getAutopromoteGroups( $this )
3643 // Assure data consistency with rights/groups,
3644 // as getEffectiveGroups() depends on this function
3645 $this->mEffectiveGroups
= null;
3648 return $this->mImplicitGroups
;
3652 * Returns the groups the user has belonged to.
3654 * The user may still belong to the returned groups. Compare with getGroups().
3656 * The function will not return groups the user had belonged to before MW 1.17
3658 * @return array Names of the groups the user has belonged to.
3660 public function getFormerGroups() {
3663 if ( is_null( $this->mFormerGroups
) ) {
3664 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3665 ?
wfGetDB( DB_MASTER
)
3666 : wfGetDB( DB_REPLICA
);
3667 $res = $db->select( 'user_former_groups',
3669 [ 'ufg_user' => $this->mId
],
3671 $this->mFormerGroups
= [];
3672 foreach ( $res as $row ) {
3673 $this->mFormerGroups
[] = $row->ufg_group
;
3677 return $this->mFormerGroups
;
3681 * Get the user's edit count.
3682 * @return int|null Null for anonymous users
3684 public function getEditCount() {
3685 if ( !$this->getId() ) {
3689 if ( $this->mEditCount
=== null ) {
3690 /* Populate the count, if it has not been populated yet */
3691 $dbr = wfGetDB( DB_REPLICA
);
3692 // check if the user_editcount field has been initialized
3693 $count = $dbr->selectField(
3694 'user', 'user_editcount',
3695 [ 'user_id' => $this->mId
],
3699 if ( $count === null ) {
3700 // it has not been initialized. do so.
3701 $count = $this->initEditCount();
3703 $this->mEditCount
= $count;
3705 return (int)$this->mEditCount
;
3709 * Add the user to the given group. This takes immediate effect.
3710 * If the user is already in the group, the expiry time will be updated to the new
3711 * expiry time. (If $expiry is omitted or null, the membership will be altered to
3714 * @param string $group Name of the group to add
3715 * @param string|null $expiry Optional expiry timestamp in any format acceptable to
3716 * wfTimestamp(), or null if the group assignment should not expire
3719 public function addGroup( $group, $expiry = null ) {
3721 $this->loadGroups();
3724 $expiry = wfTimestamp( TS_MW
, $expiry );
3727 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
3731 // create the new UserGroupMembership and put it in the DB
3732 $ugm = new UserGroupMembership( $this->mId
, $group, $expiry );
3733 if ( !$ugm->insert( true ) ) {
3737 $this->mGroupMemberships
[$group] = $ugm;
3739 // Refresh the groups caches, and clear the rights cache so it will be
3740 // refreshed on the next call to $this->getRights().
3741 $this->getEffectiveGroups( true );
3742 $this->mRights
= null;
3744 $this->invalidateCache();
3750 * Remove the user from the given group.
3751 * This takes immediate effect.
3752 * @param string $group Name of the group to remove
3755 public function removeGroup( $group ) {
3758 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3762 $ugm = UserGroupMembership
::getMembership( $this->mId
, $group );
3763 // delete the membership entry
3764 if ( !$ugm ||
!$ugm->delete() ) {
3768 $this->loadGroups();
3769 unset( $this->mGroupMemberships
[$group] );
3771 // Refresh the groups caches, and clear the rights cache so it will be
3772 // refreshed on the next call to $this->getRights().
3773 $this->getEffectiveGroups( true );
3774 $this->mRights
= null;
3776 $this->invalidateCache();
3782 * Get whether the user is logged in
3785 public function isLoggedIn() {
3786 return $this->getId() != 0;
3790 * Get whether the user is anonymous
3793 public function isAnon() {
3794 return !$this->isLoggedIn();
3798 * @return bool Whether this user is flagged as being a bot role account
3801 public function isBot() {
3802 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3807 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3813 * Check if user is allowed to access a feature / make an action
3815 * @param string $permissions,... Permissions to test
3816 * @return bool True if user is allowed to perform *any* of the given actions
3818 public function isAllowedAny() {
3819 $permissions = func_get_args();
3820 foreach ( $permissions as $permission ) {
3821 if ( $this->isAllowed( $permission ) ) {
3830 * @param string $permissions,... Permissions to test
3831 * @return bool True if the user is allowed to perform *all* of the given actions
3833 public function isAllowedAll() {
3834 $permissions = func_get_args();
3835 foreach ( $permissions as $permission ) {
3836 if ( !$this->isAllowed( $permission ) ) {
3844 * Internal mechanics of testing a permission
3845 * @param string $action
3848 public function isAllowed( $action = '' ) {
3849 if ( $action === '' ) {
3850 return true; // In the spirit of DWIM
3852 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3853 // by misconfiguration: 0 == 'foo'
3854 return in_array( $action, $this->getRights(), true );
3858 * Check whether to enable recent changes patrol features for this user
3859 * @return bool True or false
3861 public function useRCPatrol() {
3862 global $wgUseRCPatrol;
3863 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3867 * Check whether to enable new pages patrol features for this user
3868 * @return bool True or false
3870 public function useNPPatrol() {
3871 global $wgUseRCPatrol, $wgUseNPPatrol;
3873 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3874 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3879 * Check whether to enable new files patrol features for this user
3880 * @return bool True or false
3882 public function useFilePatrol() {
3883 global $wgUseRCPatrol, $wgUseFilePatrol;
3885 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3886 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3891 * Get the WebRequest object to use with this object
3893 * @return WebRequest
3895 public function getRequest() {
3896 if ( $this->mRequest
) {
3897 return $this->mRequest
;
3905 * Check the watched status of an article.
3906 * @since 1.22 $checkRights parameter added
3907 * @param Title $title Title of the article to look at
3908 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3909 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3912 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3913 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3914 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3921 * @since 1.22 $checkRights parameter added
3922 * @param Title $title Title of the article to look at
3923 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3924 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3926 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3927 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3928 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3930 [ $title->getSubjectPage(), $title->getTalkPage() ]
3933 $this->invalidateCache();
3937 * Stop watching an article.
3938 * @since 1.22 $checkRights parameter added
3939 * @param Title $title Title of the article to look at
3940 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3941 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3943 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3944 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3945 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3946 $store->removeWatch( $this, $title->getSubjectPage() );
3947 $store->removeWatch( $this, $title->getTalkPage() );
3949 $this->invalidateCache();
3953 * Clear the user's notification timestamp for the given title.
3954 * If e-notif e-mails are on, they will receive notification mails on
3955 * the next change of the page if it's watched etc.
3956 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3957 * @param Title &$title Title of the article to look at
3958 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3960 public function clearNotification( &$title, $oldid = 0 ) {
3961 global $wgUseEnotif, $wgShowUpdatedMarker;
3963 // Do nothing if the database is locked to writes
3964 if ( wfReadOnly() ) {
3968 // Do nothing if not allowed to edit the watchlist
3969 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3973 // If we're working on user's talk page, we should update the talk page message indicator
3974 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3975 // Avoid PHP 7.1 warning of passing $this by reference
3977 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
3981 // Try to update the DB post-send and only if needed...
3982 DeferredUpdates
::addCallableUpdate( function () use ( $title, $oldid ) {
3983 if ( !$this->getNewtalk() ) {
3984 return; // no notifications to clear
3987 // Delete the last notifications (they stack up)
3988 $this->setNewtalk( false );
3990 // If there is a new, unseen, revision, use its timestamp
3992 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
3995 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
4000 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4004 if ( $this->isAnon() ) {
4005 // Nothing else to do...
4009 // Only update the timestamp if the page is being watched.
4010 // The query to find out if it is watched is cached both in memcached and per-invocation,
4011 // and when it does have to be executed, it can be on a replica DB
4012 // If this is the user's newtalk page, we always update the timestamp
4014 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
4018 MediaWikiServices
::getInstance()->getWatchedItemStore()
4019 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
4023 * Resets all of the given user's page-change notification timestamps.
4024 * If e-notif e-mails are on, they will receive notification mails on
4025 * the next change of any watched page.
4026 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
4028 public function clearAllNotifications() {
4029 global $wgUseEnotif, $wgShowUpdatedMarker;
4030 // Do nothing if not allowed to edit the watchlist
4031 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
4035 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4036 $this->setNewtalk( false );
4040 $id = $this->getId();
4045 $watchedItemStore = MediaWikiServices
::getInstance()->getWatchedItemStore();
4046 $watchedItemStore->resetAllNotificationTimestampsForUser( $this );
4048 // We also need to clear here the "you have new message" notification for the own
4049 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
4053 * Compute experienced level based on edit count and registration date.
4055 * @return string 'newcomer', 'learner', or 'experienced'
4057 public function getExperienceLevel() {
4058 global $wgLearnerEdits,
4059 $wgExperiencedUserEdits,
4060 $wgLearnerMemberSince,
4061 $wgExperiencedUserMemberSince;
4063 if ( $this->isAnon() ) {
4067 $editCount = $this->getEditCount();
4068 $registration = $this->getRegistration();
4070 $learnerRegistration = wfTimestamp( TS_MW
, $now - $wgLearnerMemberSince * 86400 );
4071 $experiencedRegistration = wfTimestamp( TS_MW
, $now - $wgExperiencedUserMemberSince * 86400 );
4074 $editCount < $wgLearnerEdits ||
4075 $registration > $learnerRegistration
4079 $editCount > $wgExperiencedUserEdits &&
4080 $registration <= $experiencedRegistration
4082 return 'experienced';
4089 * Persist this user's session (e.g. set cookies)
4091 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
4093 * @param bool|null $secure Whether to force secure/insecure cookies or use default
4094 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
4096 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
4098 if ( 0 == $this->mId
) {
4102 $session = $this->getRequest()->getSession();
4103 if ( $request && $session->getRequest() !== $request ) {
4104 $session = $session->sessionWithRequest( $request );
4106 $delay = $session->delaySave();
4108 if ( !$session->getUser()->equals( $this ) ) {
4109 if ( !$session->canSetUser() ) {
4110 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4111 ->warning( __METHOD__
.
4112 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
4116 $session->setUser( $this );
4119 $session->setRememberUser( $rememberMe );
4120 if ( $secure !== null ) {
4121 $session->setForceHTTPS( $secure );
4124 $session->persist();
4126 ScopedCallback
::consume( $delay );
4130 * Log this user out.
4132 public function logout() {
4133 // Avoid PHP 7.1 warning of passing $this by reference
4135 if ( Hooks
::run( 'UserLogout', [ &$user ] ) ) {
4141 * Clear the user's session, and reset the instance cache.
4144 public function doLogout() {
4145 $session = $this->getRequest()->getSession();
4146 if ( !$session->canSetUser() ) {
4147 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4148 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
4149 $error = 'immutable';
4150 } elseif ( !$session->getUser()->equals( $this ) ) {
4151 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4152 ->warning( __METHOD__
.
4153 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
4155 // But we still may as well make this user object anon
4156 $this->clearInstanceCache( 'defaults' );
4157 $error = 'wronguser';
4159 $this->clearInstanceCache( 'defaults' );
4160 $delay = $session->delaySave();
4161 $session->unpersist(); // Clear cookies (T127436)
4162 $session->setLoggedOutTimestamp( time() );
4163 $session->setUser( new User
);
4164 $session->set( 'wsUserID', 0 ); // Other code expects this
4165 $session->resetAllTokens();
4166 ScopedCallback
::consume( $delay );
4169 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
4170 'event' => 'logout',
4171 'successful' => $error === false,
4172 'status' => $error ?
: 'success',
4177 * Save this user's settings into the database.
4178 * @todo Only rarely do all these fields need to be set!
4180 public function saveSettings() {
4181 if ( wfReadOnly() ) {
4182 // @TODO: caller should deal with this instead!
4183 // This should really just be an exception.
4184 MWExceptionHandler
::logException( new DBExpectedError(
4186 "Could not update user with ID '{$this->mId}'; DB is read-only."
4192 if ( 0 == $this->mId
) {
4196 // Get a new user_touched that is higher than the old one.
4197 // This will be used for a CAS check as a last-resort safety
4198 // check against race conditions and replica DB lag.
4199 $newTouched = $this->newTouchedTimestamp();
4201 $dbw = wfGetDB( DB_MASTER
);
4202 $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $newTouched ) {
4203 global $wgActorTableSchemaMigrationStage;
4205 $dbw->update( 'user',
4207 'user_name' => $this->mName
,
4208 'user_real_name' => $this->mRealName
,
4209 'user_email' => $this->mEmail
,
4210 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4211 'user_touched' => $dbw->timestamp( $newTouched ),
4212 'user_token' => strval( $this->mToken
),
4213 'user_email_token' => $this->mEmailToken
,
4214 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
4215 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
4216 'user_id' => $this->mId
,
4220 if ( !$dbw->affectedRows() ) {
4221 // Maybe the problem was a missed cache update; clear it to be safe
4222 $this->clearSharedCache( 'refresh' );
4223 // User was changed in the meantime or loaded with stale data
4224 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
4225 LoggerFactory
::getInstance( 'preferences' )->warning(
4226 "CAS update failed on user_touched for user ID '{user_id}' ({db_flag} read)",
4227 [ 'user_id' => $this->mId
, 'db_flag' => $from ]
4229 throw new MWException( "CAS update failed on user_touched. " .
4230 "The version of the user to be saved is older than the current version."
4234 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4237 [ 'actor_name' => $this->mName
],
4238 [ 'actor_user' => $this->mId
],
4244 $this->mTouched
= $newTouched;
4245 $this->saveOptions();
4247 Hooks
::run( 'UserSaveSettings', [ $this ] );
4248 $this->clearSharedCache();
4249 $this->getUserPage()->invalidateCache();
4253 * If only this user's username is known, and it exists, return the user ID.
4255 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
4258 public function idForName( $flags = 0 ) {
4259 $s = trim( $this->getName() );
4264 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
4265 ?
wfGetDB( DB_MASTER
)
4266 : wfGetDB( DB_REPLICA
);
4268 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
4269 ?
[ 'LOCK IN SHARE MODE' ]
4272 $id = $db->selectField( 'user',
4273 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
4279 * Add a user to the database, return the user object
4281 * @param string $name Username to add
4282 * @param array $params Array of Strings Non-default parameters to save to
4283 * the database as user_* fields:
4284 * - email: The user's email address.
4285 * - email_authenticated: The email authentication timestamp.
4286 * - real_name: The user's real name.
4287 * - options: An associative array of non-default options.
4288 * - token: Random authentication token. Do not set.
4289 * - registration: Registration timestamp. Do not set.
4291 * @return User|null User object, or null if the username already exists.
4293 public static function createNew( $name, $params = [] ) {
4294 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
4295 if ( isset( $params[$field] ) ) {
4296 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
4297 unset( $params[$field] );
4303 $user->setToken(); // init token
4304 if ( isset( $params['options'] ) ) {
4305 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
4306 unset( $params['options'] );
4308 $dbw = wfGetDB( DB_MASTER
);
4310 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4313 'user_name' => $name,
4314 'user_password' => $noPass,
4315 'user_newpassword' => $noPass,
4316 'user_email' => $user->mEmail
,
4317 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
4318 'user_real_name' => $user->mRealName
,
4319 'user_token' => strval( $user->mToken
),
4320 'user_registration' => $dbw->timestamp( $user->mRegistration
),
4321 'user_editcount' => 0,
4322 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4324 foreach ( $params as $name => $value ) {
4325 $fields["user_$name"] = $value;
4328 return $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $fields ) {
4329 $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
4330 if ( $dbw->affectedRows() ) {
4331 $newUser = self
::newFromId( $dbw->insertId() );
4332 $newUser->mName
= $fields['user_name'];
4333 $newUser->updateActorId( $dbw );
4334 // Load the user from master to avoid replica lag
4335 $newUser->load( self
::READ_LATEST
);
4344 * Add this existing user object to the database. If the user already
4345 * exists, a fatal status object is returned, and the user object is
4346 * initialised with the data from the database.
4348 * Previously, this function generated a DB error due to a key conflict
4349 * if the user already existed. Many extension callers use this function
4350 * in code along the lines of:
4352 * $user = User::newFromName( $name );
4353 * if ( !$user->isLoggedIn() ) {
4354 * $user->addToDatabase();
4356 * // do something with $user...
4358 * However, this was vulnerable to a race condition (T18020). By
4359 * initialising the user object if the user exists, we aim to support this
4360 * calling sequence as far as possible.
4362 * Note that if the user exists, this function will acquire a write lock,
4363 * so it is still advisable to make the call conditional on isLoggedIn(),
4364 * and to commit the transaction after calling.
4366 * @throws MWException
4369 public function addToDatabase() {
4371 if ( !$this->mToken
) {
4372 $this->setToken(); // init token
4375 if ( !is_string( $this->mName
) ) {
4376 throw new RuntimeException( "User name field is not set." );
4379 $this->mTouched
= $this->newTouchedTimestamp();
4381 $dbw = wfGetDB( DB_MASTER
);
4382 $status = $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) {
4383 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4384 $dbw->insert( 'user',
4386 'user_name' => $this->mName
,
4387 'user_password' => $noPass,
4388 'user_newpassword' => $noPass,
4389 'user_email' => $this->mEmail
,
4390 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4391 'user_real_name' => $this->mRealName
,
4392 'user_token' => strval( $this->mToken
),
4393 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4394 'user_editcount' => 0,
4395 'user_touched' => $dbw->timestamp( $this->mTouched
),
4399 if ( !$dbw->affectedRows() ) {
4400 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4401 $this->mId
= $dbw->selectField(
4404 [ 'user_name' => $this->mName
],
4406 [ 'LOCK IN SHARE MODE' ]
4410 if ( $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4415 throw new MWException( $fname . ": hit a key conflict attempting " .
4416 "to insert user '{$this->mName}' row, but it was not present in select!" );
4418 return Status
::newFatal( 'userexists' );
4420 $this->mId
= $dbw->insertId();
4421 self
::$idCacheByName[$this->mName
] = $this->mId
;
4422 $this->updateActorId( $dbw );
4424 return Status
::newGood();
4426 if ( !$status->isGood() ) {
4430 // Clear instance cache other than user table data and actor, which is already accurate
4431 $this->clearInstanceCache();
4433 $this->saveOptions();
4434 return Status
::newGood();
4438 * Update the actor ID after an insert
4439 * @param IDatabase $dbw Writable database handle
4441 private function updateActorId( IDatabase
$dbw ) {
4442 global $wgActorTableSchemaMigrationStage;
4444 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4447 [ 'actor_user' => $this->mId
, 'actor_name' => $this->mName
],
4450 $this->mActorId
= (int)$dbw->insertId();
4455 * If this user is logged-in and blocked,
4456 * block any IP address they've successfully logged in from.
4457 * @return bool A block was spread
4459 public function spreadAnyEditBlock() {
4460 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4461 return $this->spreadBlock();
4468 * If this (non-anonymous) user is blocked,
4469 * block the IP address they've successfully logged in from.
4470 * @return bool A block was spread
4472 protected function spreadBlock() {
4473 wfDebug( __METHOD__
. "()\n" );
4475 if ( $this->mId
== 0 ) {
4479 $userblock = Block
::newFromTarget( $this->getName() );
4480 if ( !$userblock ) {
4484 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4488 * Get whether the user is explicitly blocked from account creation.
4489 * @return bool|Block
4491 public function isBlockedFromCreateAccount() {
4492 $this->getBlockedStatus();
4493 if ( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
4494 return $this->mBlock
;
4497 # T15611: if the IP address the user is trying to create an account from is
4498 # blocked with createaccount disabled, prevent new account creation there even
4499 # when the user is logged in
4500 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4501 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4503 return $this->mBlockedFromCreateAccount
instanceof Block
4504 && $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
4505 ?
$this->mBlockedFromCreateAccount
4510 * Get whether the user is blocked from using Special:Emailuser.
4513 public function isBlockedFromEmailuser() {
4514 $this->getBlockedStatus();
4515 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
4519 * Get whether the user is allowed to create an account.
4522 public function isAllowedToCreateAccount() {
4523 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4527 * Get this user's personal page title.
4529 * @return Title User's personal page title
4531 public function getUserPage() {
4532 return Title
::makeTitle( NS_USER
, $this->getName() );
4536 * Get this user's talk page title.
4538 * @return Title User's talk page title
4540 public function getTalkPage() {
4541 $title = $this->getUserPage();
4542 return $title->getTalkPage();
4546 * Determine whether the user is a newbie. Newbies are either
4547 * anonymous IPs, or the most recently created accounts.
4550 public function isNewbie() {
4551 return !$this->isAllowed( 'autoconfirmed' );
4555 * Check to see if the given clear-text password is one of the accepted passwords
4556 * @deprecated since 1.27, use AuthManager instead
4557 * @param string $password User password
4558 * @return bool True if the given password is correct, otherwise False
4560 public function checkPassword( $password ) {
4561 wfDeprecated( __METHOD__
, '1.27' );
4563 $manager = AuthManager
::singleton();
4564 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4565 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4567 'username' => $this->getName(),
4568 'password' => $password,
4571 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4572 switch ( $res->status
) {
4573 case AuthenticationResponse
::PASS
:
4575 case AuthenticationResponse
::FAIL
:
4576 // Hope it's not a PreAuthenticationProvider that failed...
4577 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4578 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4581 throw new BadMethodCallException(
4582 'AuthManager returned a response unsupported by ' . __METHOD__
4588 * Check if the given clear-text password matches the temporary password
4589 * sent by e-mail for password reset operations.
4591 * @deprecated since 1.27, use AuthManager instead
4592 * @param string $plaintext
4593 * @return bool True if matches, false otherwise
4595 public function checkTemporaryPassword( $plaintext ) {
4596 wfDeprecated( __METHOD__
, '1.27' );
4597 // Can't check the temporary password individually.
4598 return $this->checkPassword( $plaintext );
4602 * Initialize (if necessary) and return a session token value
4603 * which can be used in edit forms to show that the user's
4604 * login credentials aren't being hijacked with a foreign form
4608 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4609 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4610 * @return MediaWiki\Session\Token The new edit token
4612 public function getEditTokenObject( $salt = '', $request = null ) {
4613 if ( $this->isAnon() ) {
4614 return new LoggedOutEditToken();
4618 $request = $this->getRequest();
4620 return $request->getSession()->getToken( $salt );
4624 * Initialize (if necessary) and return a session token value
4625 * which can be used in edit forms to show that the user's
4626 * login credentials aren't being hijacked with a foreign form
4629 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4632 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4633 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4634 * @return string The new edit token
4636 public function getEditToken( $salt = '', $request = null ) {
4637 return $this->getEditTokenObject( $salt, $request )->toString();
4641 * Check given value against the token value stored in the session.
4642 * A match should confirm that the form was submitted from the
4643 * user's own login session, not a form submission from a third-party
4646 * @param string $val Input value to compare
4647 * @param string|array $salt Optional function-specific data for hashing
4648 * @param WebRequest|null $request Object to use or null to use $wgRequest
4649 * @param int|null $maxage Fail tokens older than this, in seconds
4650 * @return bool Whether the token matches
4652 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4653 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4657 * Check given value against the token value stored in the session,
4658 * ignoring the suffix.
4660 * @param string $val Input value to compare
4661 * @param string|array $salt Optional function-specific data for hashing
4662 * @param WebRequest|null $request Object to use or null to use $wgRequest
4663 * @param int|null $maxage Fail tokens older than this, in seconds
4664 * @return bool Whether the token matches
4666 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4667 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4668 return $this->matchEditToken( $val, $salt, $request, $maxage );
4672 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4673 * mail to the user's given address.
4675 * @param string $type Message to send, either "created", "changed" or "set"
4678 public function sendConfirmationMail( $type = 'created' ) {
4680 $expiration = null; // gets passed-by-ref and defined in next line.
4681 $token = $this->confirmationToken( $expiration );
4682 $url = $this->confirmationTokenUrl( $token );
4683 $invalidateURL = $this->invalidationTokenUrl( $token );
4684 $this->saveSettings();
4686 if ( $type == 'created' ||
$type === false ) {
4687 $message = 'confirmemail_body';
4688 } elseif ( $type === true ) {
4689 $message = 'confirmemail_body_changed';
4691 // Messages: confirmemail_body_changed, confirmemail_body_set
4692 $message = 'confirmemail_body_' . $type;
4695 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4696 wfMessage( $message,
4697 $this->getRequest()->getIP(),
4700 $wgLang->userTimeAndDate( $expiration, $this ),
4702 $wgLang->userDate( $expiration, $this ),
4703 $wgLang->userTime( $expiration, $this ) )->text() );
4707 * Send an e-mail to this user's account. Does not check for
4708 * confirmed status or validity.
4710 * @param string $subject Message subject
4711 * @param string $body Message body
4712 * @param User|null $from Optional sending user; if unspecified, default
4713 * $wgPasswordSender will be used.
4714 * @param string|null $replyto Reply-To address
4717 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4718 global $wgPasswordSender;
4720 if ( $from instanceof User
) {
4721 $sender = MailAddress
::newFromUser( $from );
4723 $sender = new MailAddress( $wgPasswordSender,
4724 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4726 $to = MailAddress
::newFromUser( $this );
4728 return UserMailer
::send( $to, $sender, $subject, $body, [
4729 'replyTo' => $replyto,
4734 * Generate, store, and return a new e-mail confirmation code.
4735 * A hash (unsalted, since it's used as a key) is stored.
4737 * @note Call saveSettings() after calling this function to commit
4738 * this change to the database.
4740 * @param string &$expiration Accepts the expiration time
4741 * @return string New token
4743 protected function confirmationToken( &$expiration ) {
4744 global $wgUserEmailConfirmationTokenExpiry;
4746 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4747 $expiration = wfTimestamp( TS_MW
, $expires );
4749 $token = MWCryptRand
::generateHex( 32 );
4750 $hash = md5( $token );
4751 $this->mEmailToken
= $hash;
4752 $this->mEmailTokenExpires
= $expiration;
4757 * Return a URL the user can use to confirm their email address.
4758 * @param string $token Accepts the email confirmation token
4759 * @return string New token URL
4761 protected function confirmationTokenUrl( $token ) {
4762 return $this->getTokenUrl( 'ConfirmEmail', $token );
4766 * Return a URL the user can use to invalidate their email address.
4767 * @param string $token Accepts the email confirmation token
4768 * @return string New token URL
4770 protected function invalidationTokenUrl( $token ) {
4771 return $this->getTokenUrl( 'InvalidateEmail', $token );
4775 * Internal function to format the e-mail validation/invalidation URLs.
4776 * This uses a quickie hack to use the
4777 * hardcoded English names of the Special: pages, for ASCII safety.
4779 * @note Since these URLs get dropped directly into emails, using the
4780 * short English names avoids insanely long URL-encoded links, which
4781 * also sometimes can get corrupted in some browsers/mailers
4782 * (T8957 with Gmail and Internet Explorer).
4784 * @param string $page Special page
4785 * @param string $token
4786 * @return string Formatted URL
4788 protected function getTokenUrl( $page, $token ) {
4789 // Hack to bypass localization of 'Special:'
4790 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4791 return $title->getCanonicalURL();
4795 * Mark the e-mail address confirmed.
4797 * @note Call saveSettings() after calling this function to commit the change.
4801 public function confirmEmail() {
4802 // Check if it's already confirmed, so we don't touch the database
4803 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4804 if ( !$this->isEmailConfirmed() ) {
4805 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4806 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4812 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4813 * address if it was already confirmed.
4815 * @note Call saveSettings() after calling this function to commit the change.
4816 * @return bool Returns true
4818 public function invalidateEmail() {
4820 $this->mEmailToken
= null;
4821 $this->mEmailTokenExpires
= null;
4822 $this->setEmailAuthenticationTimestamp( null );
4824 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4829 * Set the e-mail authentication timestamp.
4830 * @param string $timestamp TS_MW timestamp
4832 public function setEmailAuthenticationTimestamp( $timestamp ) {
4834 $this->mEmailAuthenticated
= $timestamp;
4835 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4839 * Is this user allowed to send e-mails within limits of current
4840 * site configuration?
4843 public function canSendEmail() {
4844 global $wgEnableEmail, $wgEnableUserEmail;
4845 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4848 $canSend = $this->isEmailConfirmed();
4849 // Avoid PHP 7.1 warning of passing $this by reference
4851 Hooks
::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
4856 * Is this user allowed to receive e-mails within limits of current
4857 * site configuration?
4860 public function canReceiveEmail() {
4861 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4865 * Is this user's e-mail address valid-looking and confirmed within
4866 * limits of the current site configuration?
4868 * @note If $wgEmailAuthentication is on, this may require the user to have
4869 * confirmed their address by returning a code or using a password
4870 * sent to the address from the wiki.
4874 public function isEmailConfirmed() {
4875 global $wgEmailAuthentication;
4877 // Avoid PHP 7.1 warning of passing $this by reference
4880 if ( Hooks
::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
4881 if ( $this->isAnon() ) {
4884 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4887 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4897 * Check whether there is an outstanding request for e-mail confirmation.
4900 public function isEmailConfirmationPending() {
4901 global $wgEmailAuthentication;
4902 return $wgEmailAuthentication &&
4903 !$this->isEmailConfirmed() &&
4904 $this->mEmailToken
&&
4905 $this->mEmailTokenExpires
> wfTimestamp();
4909 * Get the timestamp of account creation.
4911 * @return string|bool|null Timestamp of account creation, false for
4912 * non-existent/anonymous user accounts, or null if existing account
4913 * but information is not in database.
4915 public function getRegistration() {
4916 if ( $this->isAnon() ) {
4920 return $this->mRegistration
;
4924 * Get the timestamp of the first edit
4926 * @return string|bool Timestamp of first edit, or false for
4927 * non-existent/anonymous user accounts.
4929 public function getFirstEditTimestamp() {
4930 if ( $this->getId() == 0 ) {
4931 return false; // anons
4933 $dbr = wfGetDB( DB_REPLICA
);
4934 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
4935 $time = $dbr->selectField(
4936 [ 'revision' ] +
$actorWhere['tables'],
4938 [ $actorWhere['conds'] ],
4940 [ 'ORDER BY' => 'rev_timestamp ASC' ],
4941 $actorWhere['joins']
4944 return false; // no edits
4946 return wfTimestamp( TS_MW
, $time );
4950 * Get the permissions associated with a given list of groups
4952 * @param array $groups Array of Strings List of internal group names
4953 * @return array Array of Strings List of permission key names for given groups combined
4955 public static function getGroupPermissions( $groups ) {
4956 global $wgGroupPermissions, $wgRevokePermissions;
4958 // grant every granted permission first
4959 foreach ( $groups as $group ) {
4960 if ( isset( $wgGroupPermissions[$group] ) ) {
4961 $rights = array_merge( $rights,
4962 // array_filter removes empty items
4963 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4966 // now revoke the revoked permissions
4967 foreach ( $groups as $group ) {
4968 if ( isset( $wgRevokePermissions[$group] ) ) {
4969 $rights = array_diff( $rights,
4970 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4973 return array_unique( $rights );
4977 * Get all the groups who have a given permission
4979 * @param string $role Role to check
4980 * @return array Array of Strings List of internal group names with the given permission
4982 public static function getGroupsWithPermission( $role ) {
4983 global $wgGroupPermissions;
4984 $allowedGroups = [];
4985 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4986 if ( self
::groupHasPermission( $group, $role ) ) {
4987 $allowedGroups[] = $group;
4990 return $allowedGroups;
4994 * Check, if the given group has the given permission
4996 * If you're wanting to check whether all users have a permission, use
4997 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
5001 * @param string $group Group to check
5002 * @param string $role Role to check
5005 public static function groupHasPermission( $group, $role ) {
5006 global $wgGroupPermissions, $wgRevokePermissions;
5007 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
5008 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
5012 * Check if all users may be assumed to have the given permission
5014 * We generally assume so if the right is granted to '*' and isn't revoked
5015 * on any group. It doesn't attempt to take grants or other extension
5016 * limitations on rights into account in the general case, though, as that
5017 * would require it to always return false and defeat the purpose.
5018 * Specifically, session-based rights restrictions (such as OAuth or bot
5019 * passwords) are applied based on the current session.
5022 * @param string $right Right to check
5025 public static function isEveryoneAllowed( $right ) {
5026 global $wgGroupPermissions, $wgRevokePermissions;
5029 // Use the cached results, except in unit tests which rely on
5030 // being able change the permission mid-request
5031 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
5032 return $cache[$right];
5035 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
5036 $cache[$right] = false;
5040 // If it's revoked anywhere, then everyone doesn't have it
5041 foreach ( $wgRevokePermissions as $rights ) {
5042 if ( isset( $rights[$right] ) && $rights[$right] ) {
5043 $cache[$right] = false;
5048 // Remove any rights that aren't allowed to the global-session user,
5049 // unless there are no sessions for this endpoint.
5050 if ( !defined( 'MW_NO_SESSION' ) ) {
5051 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
5052 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
5053 $cache[$right] = false;
5058 // Allow extensions to say false
5059 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
5060 $cache[$right] = false;
5064 $cache[$right] = true;
5069 * Get the localized descriptive name for a group, if it exists
5070 * @deprecated since 1.29 Use UserGroupMembership::getGroupName instead
5072 * @param string $group Internal group name
5073 * @return string Localized descriptive group name
5075 public static function getGroupName( $group ) {
5076 wfDeprecated( __METHOD__
, '1.29' );
5077 return UserGroupMembership
::getGroupName( $group );
5081 * Get the localized descriptive name for a member of a group, if it exists
5082 * @deprecated since 1.29 Use UserGroupMembership::getGroupMemberName instead
5084 * @param string $group Internal group name
5085 * @param string $username Username for gender (since 1.19)
5086 * @return string Localized name for group member
5088 public static function getGroupMember( $group, $username = '#' ) {
5089 wfDeprecated( __METHOD__
, '1.29' );
5090 return UserGroupMembership
::getGroupMemberName( $group, $username );
5094 * Return the set of defined explicit groups.
5095 * The implicit groups (by default *, 'user' and 'autoconfirmed')
5096 * are not included, as they are defined automatically, not in the database.
5097 * @return array Array of internal group names
5099 public static function getAllGroups() {
5100 global $wgGroupPermissions, $wgRevokePermissions;
5101 return array_values( array_diff(
5102 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
5103 self
::getImplicitGroups()
5108 * Get a list of all available permissions.
5109 * @return string[] Array of permission names
5111 public static function getAllRights() {
5112 if ( self
::$mAllRights === false ) {
5113 global $wgAvailableRights;
5114 if ( count( $wgAvailableRights ) ) {
5115 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
5117 self
::$mAllRights = self
::$mCoreRights;
5119 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
5121 return self
::$mAllRights;
5125 * Get a list of implicit groups
5126 * TODO: Should we deprecate this? It's trivial, but we don't want to encourage use of globals.
5128 * @return array Array of Strings Array of internal group names
5130 public static function getImplicitGroups() {
5131 global $wgImplicitGroups;
5132 return $wgImplicitGroups;
5136 * Get the title of a page describing a particular group
5137 * @deprecated since 1.29 Use UserGroupMembership::getGroupPage instead
5139 * @param string $group Internal group name
5140 * @return Title|bool Title of the page if it exists, false otherwise
5142 public static function getGroupPage( $group ) {
5143 wfDeprecated( __METHOD__
, '1.29' );
5144 return UserGroupMembership
::getGroupPage( $group );
5148 * Create a link to the group in HTML, if available;
5149 * else return the group name.
5150 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5151 * make the link yourself if you need custom text
5153 * @param string $group Internal name of the group
5154 * @param string $text The text of the link
5155 * @return string HTML link to the group
5157 public static function makeGroupLinkHTML( $group, $text = '' ) {
5158 wfDeprecated( __METHOD__
, '1.29' );
5160 if ( $text == '' ) {
5161 $text = UserGroupMembership
::getGroupName( $group );
5163 $title = UserGroupMembership
::getGroupPage( $group );
5165 return MediaWikiServices
::getInstance()
5166 ->getLinkRenderer()->makeLink( $title, $text );
5168 return htmlspecialchars( $text );
5173 * Create a link to the group in Wikitext, if available;
5174 * else return the group name.
5175 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5176 * make the link yourself if you need custom text
5178 * @param string $group Internal name of the group
5179 * @param string $text The text of the link
5180 * @return string Wikilink to the group
5182 public static function makeGroupLinkWiki( $group, $text = '' ) {
5183 wfDeprecated( __METHOD__
, '1.29' );
5185 if ( $text == '' ) {
5186 $text = UserGroupMembership
::getGroupName( $group );
5188 $title = UserGroupMembership
::getGroupPage( $group );
5190 $page = $title->getFullText();
5191 return "[[$page|$text]]";
5198 * Returns an array of the groups that a particular group can add/remove.
5200 * @param string $group The group to check for whether it can add/remove
5201 * @return array Array( 'add' => array( addablegroups ),
5202 * 'remove' => array( removablegroups ),
5203 * 'add-self' => array( addablegroups to self),
5204 * 'remove-self' => array( removable groups from self) )
5206 public static function changeableByGroup( $group ) {
5207 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
5216 if ( empty( $wgAddGroups[$group] ) ) {
5217 // Don't add anything to $groups
5218 } elseif ( $wgAddGroups[$group] === true ) {
5219 // You get everything
5220 $groups['add'] = self
::getAllGroups();
5221 } elseif ( is_array( $wgAddGroups[$group] ) ) {
5222 $groups['add'] = $wgAddGroups[$group];
5225 // Same thing for remove
5226 if ( empty( $wgRemoveGroups[$group] ) ) {
5228 } elseif ( $wgRemoveGroups[$group] === true ) {
5229 $groups['remove'] = self
::getAllGroups();
5230 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
5231 $groups['remove'] = $wgRemoveGroups[$group];
5234 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
5235 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
5236 foreach ( $wgGroupsAddToSelf as $key => $value ) {
5237 if ( is_int( $key ) ) {
5238 $wgGroupsAddToSelf['user'][] = $value;
5243 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
5244 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
5245 if ( is_int( $key ) ) {
5246 $wgGroupsRemoveFromSelf['user'][] = $value;
5251 // Now figure out what groups the user can add to him/herself
5252 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
5254 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
5255 // No idea WHY this would be used, but it's there
5256 $groups['add-self'] = self
::getAllGroups();
5257 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
5258 $groups['add-self'] = $wgGroupsAddToSelf[$group];
5261 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
5263 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
5264 $groups['remove-self'] = self
::getAllGroups();
5265 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
5266 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
5273 * Returns an array of groups that this user can add and remove
5274 * @return array Array( 'add' => array( addablegroups ),
5275 * 'remove' => array( removablegroups ),
5276 * 'add-self' => array( addablegroups to self),
5277 * 'remove-self' => array( removable groups from self) )
5279 public function changeableGroups() {
5280 if ( $this->isAllowed( 'userrights' ) ) {
5281 // This group gives the right to modify everything (reverse-
5282 // compatibility with old "userrights lets you change
5284 // Using array_merge to make the groups reindexed
5285 $all = array_merge( self
::getAllGroups() );
5294 // Okay, it's not so simple, we will have to go through the arrays
5301 $addergroups = $this->getEffectiveGroups();
5303 foreach ( $addergroups as $addergroup ) {
5304 $groups = array_merge_recursive(
5305 $groups, $this->changeableByGroup( $addergroup )
5307 $groups['add'] = array_unique( $groups['add'] );
5308 $groups['remove'] = array_unique( $groups['remove'] );
5309 $groups['add-self'] = array_unique( $groups['add-self'] );
5310 $groups['remove-self'] = array_unique( $groups['remove-self'] );
5316 * Deferred version of incEditCountImmediate()
5318 * This function, rather than incEditCountImmediate(), should be used for
5319 * most cases as it avoids potential deadlocks caused by concurrent editing.
5321 public function incEditCount() {
5322 wfGetDB( DB_MASTER
)->onTransactionPreCommitOrIdle(
5324 $this->incEditCountImmediate();
5331 * Increment the user's edit-count field.
5332 * Will have no effect for anonymous users.
5335 public function incEditCountImmediate() {
5336 if ( $this->isAnon() ) {
5340 $dbw = wfGetDB( DB_MASTER
);
5341 // No rows will be "affected" if user_editcount is NULL
5344 [ 'user_editcount=user_editcount+1' ],
5345 [ 'user_id' => $this->getId(), 'user_editcount IS NOT NULL' ],
5348 // Lazy initialization check...
5349 if ( $dbw->affectedRows() == 0 ) {
5350 // Now here's a goddamn hack...
5351 $dbr = wfGetDB( DB_REPLICA
);
5352 if ( $dbr !== $dbw ) {
5353 // If we actually have a replica DB server, the count is
5354 // at least one behind because the current transaction
5355 // has not been committed and replicated.
5356 $this->mEditCount
= $this->initEditCount( 1 );
5358 // But if DB_REPLICA is selecting the master, then the
5359 // count we just read includes the revision that was
5360 // just added in the working transaction.
5361 $this->mEditCount
= $this->initEditCount();
5364 if ( $this->mEditCount
=== null ) {
5365 $this->getEditCount();
5366 $dbr = wfGetDB( DB_REPLICA
);
5367 $this->mEditCount +
= ( $dbr !== $dbw ) ?
1 : 0;
5369 $this->mEditCount++
;
5372 // Edit count in user cache too
5373 $this->invalidateCache();
5377 * Initialize user_editcount from data out of the revision table
5379 * @param int $add Edits to add to the count from the revision table
5380 * @return int Number of edits
5382 protected function initEditCount( $add = 0 ) {
5383 // Pull from a replica DB to be less cruel to servers
5384 // Accuracy isn't the point anyway here
5385 $dbr = wfGetDB( DB_REPLICA
);
5386 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5387 $count = (int)$dbr->selectField(
5388 [ 'revision' ] +
$actorWhere['tables'],
5390 [ $actorWhere['conds'] ],
5393 $actorWhere['joins']
5395 $count = $count +
$add;
5397 $dbw = wfGetDB( DB_MASTER
);
5400 [ 'user_editcount' => $count ],
5401 [ 'user_id' => $this->getId() ],
5409 * Get the description of a given right
5412 * @param string $right Right to query
5413 * @return string Localized description of the right
5415 public static function getRightDescription( $right ) {
5416 $key = "right-$right";
5417 $msg = wfMessage( $key );
5418 return $msg->isDisabled() ?
$right : $msg->text();
5422 * Get the name of a given grant
5425 * @param string $grant Grant to query
5426 * @return string Localized name of the grant
5428 public static function getGrantName( $grant ) {
5429 $key = "grant-$grant";
5430 $msg = wfMessage( $key );
5431 return $msg->isDisabled() ?
$grant : $msg->text();
5435 * Add a newuser log entry for this user.
5436 * Before 1.19 the return value was always true.
5438 * @deprecated since 1.27, AuthManager handles logging
5439 * @param string|bool $action Account creation type.
5440 * - String, one of the following values:
5441 * - 'create' for an anonymous user creating an account for himself.
5442 * This will force the action's performer to be the created user itself,
5443 * no matter the value of $wgUser
5444 * - 'create2' for a logged in user creating an account for someone else
5445 * - 'byemail' when the created user will receive its password by e-mail
5446 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5447 * - Boolean means whether the account was created by e-mail (deprecated):
5448 * - true will be converted to 'byemail'
5449 * - false will be converted to 'create' if this object is the same as
5450 * $wgUser and to 'create2' otherwise
5451 * @param string $reason User supplied reason
5454 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5455 return true; // disabled
5459 * Add an autocreate newuser log entry for this user
5460 * Used by things like CentralAuth and perhaps other authplugins.
5461 * Consider calling addNewUserLogEntry() directly instead.
5463 * @deprecated since 1.27, AuthManager handles logging
5466 public function addNewUserLogEntryAutoCreate() {
5467 $this->addNewUserLogEntry( 'autocreate' );
5473 * Load the user options either from cache, the database or an array
5475 * @param array|null $data Rows for the current user out of the user_properties table
5477 protected function loadOptions( $data = null ) {
5480 if ( $this->mOptionsLoaded
) {
5484 $this->mOptions
= self
::getDefaultOptions();
5486 if ( !$this->getId() ) {
5487 // For unlogged-in users, load language/variant options from request.
5488 // There's no need to do it for logged-in users: they can set preferences,
5489 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5490 // so don't override user's choice (especially when the user chooses site default).
5491 $variant = MediaWikiServices
::getInstance()->getContentLanguage()->getDefaultVariant();
5492 $this->mOptions
['variant'] = $variant;
5493 $this->mOptions
['language'] = $variant;
5494 $this->mOptionsLoaded
= true;
5498 // Maybe load from the object
5499 if ( !is_null( $this->mOptionOverrides
) ) {
5500 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5501 foreach ( $this->mOptionOverrides
as $key => $value ) {
5502 $this->mOptions
[$key] = $value;
5505 if ( !is_array( $data ) ) {
5506 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5507 // Load from database
5508 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5509 ?
wfGetDB( DB_MASTER
)
5510 : wfGetDB( DB_REPLICA
);
5512 $res = $dbr->select(
5514 [ 'up_property', 'up_value' ],
5515 [ 'up_user' => $this->getId() ],
5519 $this->mOptionOverrides
= [];
5521 foreach ( $res as $row ) {
5522 // Convert '0' to 0. PHP's boolean conversion considers them both
5523 // false, but e.g. JavaScript considers the former as true.
5524 // @todo: T54542 Somehow determine the desired type (string/int/bool)
5525 // and convert all values here.
5526 if ( $row->up_value
=== '0' ) {
5529 $data[$row->up_property
] = $row->up_value
;
5533 foreach ( $data as $property => $value ) {
5534 $this->mOptionOverrides
[$property] = $value;
5535 $this->mOptions
[$property] = $value;
5539 // Replace deprecated language codes
5540 $this->mOptions
['language'] = LanguageCode
::replaceDeprecatedCodes(
5541 $this->mOptions
['language']
5544 $this->mOptionsLoaded
= true;
5546 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5550 * Saves the non-default options for this user, as previously set e.g. via
5551 * setOption(), in the database's "user_properties" (preferences) table.
5552 * Usually used via saveSettings().
5554 protected function saveOptions() {
5555 $this->loadOptions();
5557 // Not using getOptions(), to keep hidden preferences in database
5558 $saveOptions = $this->mOptions
;
5560 // Allow hooks to abort, for instance to save to a global profile.
5561 // Reset options to default state before saving.
5562 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5566 $userId = $this->getId();
5568 $insert_rows = []; // all the new preference rows
5569 foreach ( $saveOptions as $key => $value ) {
5570 // Don't bother storing default values
5571 $defaultOption = self
::getDefaultOption( $key );
5572 if ( ( $defaultOption === null && $value !== false && $value !== null )
5573 ||
$value != $defaultOption
5576 'up_user' => $userId,
5577 'up_property' => $key,
5578 'up_value' => $value,
5583 $dbw = wfGetDB( DB_MASTER
);
5585 $res = $dbw->select( 'user_properties',
5586 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5588 // Find prior rows that need to be removed or updated. These rows will
5589 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5591 foreach ( $res as $row ) {
5592 if ( !isset( $saveOptions[$row->up_property
] )
5593 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5595 $keysDelete[] = $row->up_property
;
5599 if ( count( $keysDelete ) ) {
5600 // Do the DELETE by PRIMARY KEY for prior rows.
5601 // In the past a very large portion of calls to this function are for setting
5602 // 'rememberpassword' for new accounts (a preference that has since been removed).
5603 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5604 // caused gap locks on [max user ID,+infinity) which caused high contention since
5605 // updates would pile up on each other as they are for higher (newer) user IDs.
5606 // It might not be necessary these days, but it shouldn't hurt either.
5607 $dbw->delete( 'user_properties',
5608 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5610 // Insert the new preference rows
5611 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5615 * Return the list of user fields that should be selected to create
5616 * a new user object.
5617 * @deprecated since 1.31, use self::getQueryInfo() instead.
5620 public static function selectFields() {
5621 wfDeprecated( __METHOD__
, '1.31' );
5629 'user_email_authenticated',
5631 'user_email_token_expires',
5632 'user_registration',
5638 * Return the tables, fields, and join conditions to be selected to create
5639 * a new user object.
5641 * @return array With three keys:
5642 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
5643 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
5644 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
5646 public static function getQueryInfo() {
5647 global $wgActorTableSchemaMigrationStage;
5650 'tables' => [ 'user' ],
5658 'user_email_authenticated',
5660 'user_email_token_expires',
5661 'user_registration',
5667 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
5668 // but it does little harm and might be needed for write callers loading a User.
5669 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
5670 $ret['tables']['user_actor'] = 'actor';
5671 $ret['fields'][] = 'user_actor.actor_id';
5672 $ret['joins']['user_actor'] = [
5673 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) ?
'JOIN' : 'LEFT JOIN',
5674 [ 'user_actor.actor_user = user_id' ]
5682 * Factory function for fatal permission-denied errors
5685 * @param string $permission User right required
5688 static function newFatalPermissionDeniedStatus( $permission ) {
5692 foreach ( self
::getGroupsWithPermission( $permission ) as $group ) {
5693 $groups[] = UserGroupMembership
::getLink( $group, RequestContext
::getMain(), 'wiki' );
5697 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5699 return Status
::newFatal( 'badaccess-group0' );
5704 * Get a new instance of this user that was loaded from the master via a locking read
5706 * Use this instead of the main context User when updating that user. This avoids races
5707 * where that user was loaded from a replica DB or even the master but without proper locks.
5709 * @return User|null Returns null if the user was not found in the DB
5712 public function getInstanceForUpdate() {
5713 if ( !$this->getId() ) {
5714 return null; // anon
5717 $user = self
::newFromId( $this->getId() );
5718 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5726 * Checks if two user objects point to the same user.
5728 * @since 1.25 ; takes a UserIdentity instead of a User since 1.32
5729 * @param UserIdentity $user
5732 public function equals( UserIdentity
$user ) {
5733 // XXX it's not clear whether central ID providers are supposed to obey this
5734 return $this->getName() === $user->getName();