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 = MediaWikiServices
::getInstance()->getMainWANObjectCache();
496 $key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
497 $cache->delete( $key );
502 * @param WANObjectCache $cache
505 protected function getCacheKey( WANObjectCache
$cache ) {
506 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
507 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
509 return $cache->makeGlobalKey( 'user', 'id', $lbFactory->getLocalDomainID(), $this->mId
);
513 * @param WANObjectCache $cache
517 public function getMutableCacheKeys( WANObjectCache
$cache ) {
518 $id = $this->getId();
520 return $id ?
[ $this->getCacheKey( $cache ) ] : [];
524 * Load user data from shared cache, given mId has already been set.
529 protected function loadFromCache() {
530 $cache = ObjectCache
::getMainWANInstance();
531 $data = $cache->getWithSetCallback(
532 $this->getCacheKey( $cache ),
534 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
535 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
536 wfDebug( "User: cache miss for user {$this->mId}\n" );
538 $this->loadFromDatabase( self
::READ_NORMAL
);
540 $this->loadOptions();
543 foreach ( self
::$mCacheVars as $name ) {
544 $data[$name] = $this->$name;
547 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->mTouched
), $ttl );
549 // if a user group membership is about to expire, the cache needs to
550 // expire at that time (T163691)
551 foreach ( $this->mGroupMemberships
as $ugm ) {
552 if ( $ugm->getExpiry() ) {
553 $secondsUntilExpiry = wfTimestamp( TS_UNIX
, $ugm->getExpiry() ) - time();
554 if ( $secondsUntilExpiry > 0 && $secondsUntilExpiry < $ttl ) {
555 $ttl = $secondsUntilExpiry;
562 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'version' => self
::VERSION
]
565 // Restore from cache
566 foreach ( self
::$mCacheVars as $name ) {
567 $this->$name = $data[$name];
573 /** @name newFrom*() static factory methods */
577 * Static factory method for creation from username.
579 * This is slightly less efficient than newFromId(), so use newFromId() if
580 * you have both an ID and a name handy.
582 * @param string $name Username, validated by Title::newFromText()
583 * @param string|bool $validate Validate username. Takes the same parameters as
584 * User::getCanonicalName(), except that true is accepted as an alias
585 * for 'valid', for BC.
587 * @return User|bool User object, or false if the username is invalid
588 * (e.g. if it contains illegal characters or is an IP address). If the
589 * username is not present in the database, the result will be a user object
590 * with a name, zero user ID and default settings.
592 public static function newFromName( $name, $validate = 'valid' ) {
593 if ( $validate === true ) {
596 $name = self
::getCanonicalName( $name, $validate );
597 if ( $name === false ) {
600 // Create unloaded user object
604 $u->setItemLoaded( 'name' );
610 * Static factory method for creation from a given user ID.
612 * @param int $id Valid user ID
613 * @return User The corresponding User object
615 public static function newFromId( $id ) {
619 $u->setItemLoaded( 'id' );
624 * Static factory method for creation from a given actor ID.
627 * @param int $id Valid actor ID
628 * @return User The corresponding User object
630 public static function newFromActorId( $id ) {
631 global $wgActorTableSchemaMigrationStage;
633 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
634 // but it does little harm and might be needed for write callers loading a User.
635 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) ) {
636 throw new BadMethodCallException(
637 'Cannot use ' . __METHOD__
638 . ' when $wgActorTableSchemaMigrationStage lacks SCHEMA_COMPAT_NEW'
645 $u->setItemLoaded( 'actor' );
650 * Returns a User object corresponding to the given UserIdentity.
654 * @param UserIdentity $identity
658 public static function newFromIdentity( UserIdentity
$identity ) {
659 if ( $identity instanceof User
) {
663 return self
::newFromAnyId(
664 $identity->getId() === 0 ?
null : $identity->getId(),
665 $identity->getName() === '' ?
null : $identity->getName(),
666 $identity->getActorId() === 0 ?
null : $identity->getActorId()
671 * Static factory method for creation from an ID, name, and/or actor ID
673 * This does not check that the ID, name, and actor ID all correspond to
677 * @param int|null $userId User ID, if known
678 * @param string|null $userName User name, if known
679 * @param int|null $actorId Actor ID, if known
682 public static function newFromAnyId( $userId, $userName, $actorId ) {
683 global $wgActorTableSchemaMigrationStage;
686 $user->mFrom
= 'defaults';
688 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
689 // but it does little harm and might be needed for write callers loading a User.
690 if ( ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) && $actorId !== null ) {
691 $user->mActorId
= (int)$actorId;
692 if ( $user->mActorId
!== 0 ) {
693 $user->mFrom
= 'actor';
695 $user->setItemLoaded( 'actor' );
698 if ( $userName !== null && $userName !== '' ) {
699 $user->mName
= $userName;
700 $user->mFrom
= 'name';
701 $user->setItemLoaded( 'name' );
704 if ( $userId !== null ) {
705 $user->mId
= (int)$userId;
706 if ( $user->mId
!== 0 ) {
709 $user->setItemLoaded( 'id' );
712 if ( $user->mFrom
=== 'defaults' ) {
713 throw new InvalidArgumentException(
714 'Cannot create a user with no name, no ID, and no actor ID'
722 * Factory method to fetch whichever user has a given email confirmation code.
723 * This code is generated when an account is created or its e-mail address
726 * If the code is invalid or has expired, returns NULL.
728 * @param string $code Confirmation code
729 * @param int $flags User::READ_* bitfield
732 public static function newFromConfirmationCode( $code, $flags = 0 ) {
733 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
734 ?
wfGetDB( DB_MASTER
)
735 : wfGetDB( DB_REPLICA
);
737 $id = $db->selectField(
741 'user_email_token' => md5( $code ),
742 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
746 return $id ? self
::newFromId( $id ) : null;
750 * Create a new user object using data from session. If the login
751 * credentials are invalid, the result is an anonymous user.
753 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
756 public static function newFromSession( WebRequest
$request = null ) {
758 $user->mFrom
= 'session';
759 $user->mRequest
= $request;
764 * Create a new user object from a user row.
765 * The row should have the following fields from the user table in it:
766 * - either user_name or user_id to load further data if needed (or both)
768 * - all other fields (email, etc.)
769 * It is useless to provide the remaining fields if either user_id,
770 * user_name and user_real_name are not provided because the whole row
771 * will be loaded once more from the database when accessing them.
773 * @param stdClass $row A row from the user table
774 * @param array|null $data Further data to load into the object
775 * (see User::loadFromRow for valid keys)
778 public static function newFromRow( $row, $data = null ) {
780 $user->loadFromRow( $row, $data );
785 * Static factory method for creation of a "system" user from username.
787 * A "system" user is an account that's used to attribute logged actions
788 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
789 * might include the 'Maintenance script' or 'Conversion script' accounts
790 * used by various scripts in the maintenance/ directory or accounts such
791 * as 'MediaWiki message delivery' used by the MassMessage extension.
793 * This can optionally create the user if it doesn't exist, and "steal" the
794 * account if it does exist.
796 * "Stealing" an existing user is intended to make it impossible for normal
797 * authentication processes to use the account, effectively disabling the
798 * account for normal use:
799 * - Email is invalidated, to prevent account recovery by emailing a
800 * temporary password and to disassociate the account from the existing
802 * - The token is set to a magic invalid value, to kill existing sessions
803 * and to prevent $this->setToken() calls from resetting the token to a
805 * - SessionManager is instructed to prevent new sessions for the user, to
806 * do things like deauthorizing OAuth consumers.
807 * - AuthManager is instructed to revoke access, to invalidate or remove
808 * passwords and other credentials.
810 * @param string $name Username
811 * @param array $options Options are:
812 * - validate: As for User::getCanonicalName(), default 'valid'
813 * - create: Whether to create the user if it doesn't already exist, default true
814 * - steal: Whether to "disable" the account for normal use if it already
815 * exists, default false
819 public static function newSystemUser( $name, $options = [] ) {
821 'validate' => 'valid',
826 $name = self
::getCanonicalName( $name, $options['validate'] );
827 if ( $name === false ) {
831 $dbr = wfGetDB( DB_REPLICA
);
832 $userQuery = self
::getQueryInfo();
833 $row = $dbr->selectRow(
834 $userQuery['tables'],
835 $userQuery['fields'],
836 [ 'user_name' => $name ],
842 // Try the master database...
843 $dbw = wfGetDB( DB_MASTER
);
844 $row = $dbw->selectRow(
845 $userQuery['tables'],
846 $userQuery['fields'],
847 [ 'user_name' => $name ],
855 // No user. Create it?
856 return $options['create']
857 ? self
::createNew( $name, [ 'token' => self
::INVALID_TOKEN
] )
861 $user = self
::newFromRow( $row );
863 // A user is considered to exist as a non-system user if it can
864 // authenticate, or has an email set, or has a non-invalid token.
865 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
866 AuthManager
::singleton()->userCanAuthenticate( $name )
868 // User exists. Steal it?
869 if ( !$options['steal'] ) {
873 AuthManager
::singleton()->revokeAccessForUser( $name );
875 $user->invalidateEmail();
876 $user->mToken
= self
::INVALID_TOKEN
;
877 $user->saveSettings();
878 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
887 * Get the username corresponding to a given user ID
888 * @param int $id User ID
889 * @return string|bool The corresponding username
891 public static function whoIs( $id ) {
892 return UserCache
::singleton()->getProp( $id, 'name' );
896 * Get the real name of a user given their user ID
898 * @param int $id User ID
899 * @return string|bool The corresponding user's real name
901 public static function whoIsReal( $id ) {
902 return UserCache
::singleton()->getProp( $id, 'real_name' );
906 * Get database id given a user name
907 * @param string $name Username
908 * @param int $flags User::READ_* constant bitfield
909 * @return int|null The corresponding user's ID, or null if user is nonexistent
911 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
912 $nt = Title
::makeTitleSafe( NS_USER
, $name );
913 if ( is_null( $nt ) ) {
918 if ( !( $flags & self
::READ_LATEST
) && array_key_exists( $name, self
::$idCacheByName ) ) {
919 return self
::$idCacheByName[$name];
922 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
923 $db = wfGetDB( $index );
928 [ 'user_name' => $nt->getText() ],
933 if ( $s === false ) {
936 $result = $s->user_id
;
939 self
::$idCacheByName[$name] = $result;
941 if ( count( self
::$idCacheByName ) > 1000 ) {
942 self
::$idCacheByName = [];
949 * Reset the cache used in idFromName(). For use in tests.
951 public static function resetIdByNameCache() {
952 self
::$idCacheByName = [];
956 * Does the string match an anonymous IP address?
958 * This function exists for username validation, in order to reject
959 * usernames which are similar in form to IP addresses. Strings such
960 * as 300.300.300.300 will return true because it looks like an IP
961 * address, despite not being strictly valid.
963 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
964 * address because the usemod software would "cloak" anonymous IP
965 * addresses like this, if we allowed accounts like this to be created
966 * new users could get the old edits of these anonymous users.
968 * @param string $name Name to match
971 public static function isIP( $name ) {
972 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
973 || IP
::isIPv6( $name );
977 * Is the user an IP range?
982 public function isIPRange() {
983 return IP
::isValidRange( $this->mName
);
987 * Is the input a valid username?
989 * Checks if the input is a valid username, we don't want an empty string,
990 * an IP address, anything that contains slashes (would mess up subpages),
991 * is longer than the maximum allowed username size or doesn't begin with
994 * @param string $name Name to match
997 public static function isValidUserName( $name ) {
998 global $wgMaxNameChars;
1001 || self
::isIP( $name )
1002 ||
strpos( $name, '/' ) !== false
1003 ||
strlen( $name ) > $wgMaxNameChars
1004 ||
$name != MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name )
1009 // Ensure that the name can't be misresolved as a different title,
1010 // such as with extra namespace keys at the start.
1011 $parsed = Title
::newFromText( $name );
1012 if ( is_null( $parsed )
1013 ||
$parsed->getNamespace()
1014 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
1018 // Check an additional blacklist of troublemaker characters.
1019 // Should these be merged into the title char list?
1020 $unicodeBlacklist = '/[' .
1021 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
1022 '\x{00a0}' . # non-breaking space
1023 '\x{2000}-\x{200f}' . # various whitespace
1024 '\x{2028}-\x{202f}' . # breaks and control chars
1025 '\x{3000}' . # ideographic space
1026 '\x{e000}-\x{f8ff}' . # private use
1028 if ( preg_match( $unicodeBlacklist, $name ) ) {
1036 * Usernames which fail to pass this function will be blocked
1037 * from user login and new account registrations, but may be used
1038 * internally by batch processes.
1040 * If an account already exists in this form, login will be blocked
1041 * by a failure to pass this function.
1043 * @param string $name Name to match
1046 public static function isUsableName( $name ) {
1047 global $wgReservedUsernames;
1048 // Must be a valid username, obviously ;)
1049 if ( !self
::isValidUserName( $name ) ) {
1053 static $reservedUsernames = false;
1054 if ( !$reservedUsernames ) {
1055 $reservedUsernames = $wgReservedUsernames;
1056 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
1059 // Certain names may be reserved for batch processes.
1060 foreach ( $reservedUsernames as $reserved ) {
1061 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
1062 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->plain();
1064 if ( $reserved == $name ) {
1072 * Return the users who are members of the given group(s). In case of multiple groups,
1073 * users who are members of at least one of them are returned.
1075 * @param string|array $groups A single group name or an array of group names
1076 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
1077 * records; larger values are ignored.
1078 * @param int|null $after ID the user to start after
1079 * @return UserArrayFromResult
1081 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
1082 if ( $groups === [] ) {
1083 return UserArrayFromResult
::newFromIDs( [] );
1086 $groups = array_unique( (array)$groups );
1087 $limit = min( 5000, $limit );
1089 $conds = [ 'ug_group' => $groups ];
1090 if ( $after !== null ) {
1091 $conds[] = 'ug_user > ' . (int)$after;
1094 $dbr = wfGetDB( DB_REPLICA
);
1095 $ids = $dbr->selectFieldValues(
1102 'ORDER BY' => 'ug_user',
1106 return UserArray
::newFromIDs( $ids );
1110 * Usernames which fail to pass this function will be blocked
1111 * from new account registrations, but may be used internally
1112 * either by batch processes or by user accounts which have
1113 * already been created.
1115 * Additional blacklisting may be added here rather than in
1116 * isValidUserName() to avoid disrupting existing accounts.
1118 * @param string $name String to match
1121 public static function isCreatableName( $name ) {
1122 global $wgInvalidUsernameCharacters;
1124 // Ensure that the username isn't longer than 235 bytes, so that
1125 // (at least for the builtin skins) user javascript and css files
1126 // will work. (T25080)
1127 if ( strlen( $name ) > 235 ) {
1128 wfDebugLog( 'username', __METHOD__
.
1129 ": '$name' invalid due to length" );
1133 // Preg yells if you try to give it an empty string
1134 if ( $wgInvalidUsernameCharacters !== '' ) {
1135 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
1136 wfDebugLog( 'username', __METHOD__
.
1137 ": '$name' invalid due to wgInvalidUsernameCharacters" );
1142 return self
::isUsableName( $name );
1146 * Is the input a valid password for this user?
1148 * @param string $password Desired password
1151 public function isValidPassword( $password ) {
1152 // simple boolean wrapper for getPasswordValidity
1153 return $this->getPasswordValidity( $password ) === true;
1157 * Given unvalidated password input, return error message on failure.
1159 * @param string $password Desired password
1160 * @return bool|string|array True on success, string or array of error message on failure
1162 public function getPasswordValidity( $password ) {
1163 $result = $this->checkPasswordValidity( $password );
1164 if ( $result->isGood() ) {
1168 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
1169 $messages[] = $error['message'];
1171 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
1172 $messages[] = $warning['message'];
1174 if ( count( $messages ) === 1 ) {
1175 return $messages[0];
1182 * Check if this is a valid password for this user
1184 * Create a Status object based on the password's validity.
1185 * The Status should be set to fatal if the user should not
1186 * be allowed to log in, and should have any errors that
1187 * would block changing the password.
1189 * If the return value of this is not OK, the password
1190 * should not be checked. If the return value is not Good,
1191 * the password can be checked, but the user should not be
1192 * able to set their password to this.
1194 * @param string $password Desired password
1198 public function checkPasswordValidity( $password ) {
1199 global $wgPasswordPolicy;
1201 $upp = new UserPasswordPolicy(
1202 $wgPasswordPolicy['policies'],
1203 $wgPasswordPolicy['checks']
1206 $status = Status
::newGood();
1207 $result = false; // init $result to false for the internal checks
1209 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1210 $status->error( $result );
1214 if ( $result === false ) {
1215 $status->merge( $upp->checkUserPassword( $this, $password ) );
1217 } elseif ( $result === true ) {
1220 $status->error( $result );
1221 return $status; // the isValidPassword hook set a string $result and returned true
1226 * Given unvalidated user input, return a canonical username, or false if
1227 * the username is invalid.
1228 * @param string $name User input
1229 * @param string|bool $validate Type of validation to use:
1230 * - false No validation
1231 * - 'valid' Valid for batch processes
1232 * - 'usable' Valid for batch processes and login
1233 * - 'creatable' Valid for batch processes, login and account creation
1235 * @throws InvalidArgumentException
1236 * @return bool|string
1238 public static function getCanonicalName( $name, $validate = 'valid' ) {
1239 // Force usernames to capital
1240 $name = MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name );
1242 # Reject names containing '#'; these will be cleaned up
1243 # with title normalisation, but then it's too late to
1245 if ( strpos( $name, '#' ) !== false ) {
1249 // Clean up name according to title rules,
1250 // but only when validation is requested (T14654)
1251 $t = ( $validate !== false ) ?
1252 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1253 // Check for invalid titles
1254 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1258 // Reject various classes of invalid names
1259 $name = AuthManager
::callLegacyAuthPlugin(
1260 'getCanonicalName', [ $t->getText() ], $t->getText()
1263 switch ( $validate ) {
1267 if ( !self
::isValidUserName( $name ) ) {
1272 if ( !self
::isUsableName( $name ) ) {
1277 if ( !self
::isCreatableName( $name ) ) {
1282 throw new InvalidArgumentException(
1283 'Invalid parameter value for $validate in ' . __METHOD__
);
1289 * Return a random password.
1291 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1292 * @return string New random password
1294 public static function randomPassword() {
1295 global $wgMinimalPasswordLength;
1296 return PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1300 * Set cached properties to default.
1302 * @note This no longer clears uncached lazy-initialised properties;
1303 * the constructor does that instead.
1305 * @param string|bool $name
1307 public function loadDefaults( $name = false ) {
1309 $this->mName
= $name;
1310 $this->mActorId
= null;
1311 $this->mRealName
= '';
1313 $this->mOptionOverrides
= null;
1314 $this->mOptionsLoaded
= false;
1316 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1317 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1318 if ( $loggedOut !== 0 ) {
1319 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1321 $this->mTouched
= '1'; # Allow any pages to be cached
1324 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1325 $this->mEmailAuthenticated
= null;
1326 $this->mEmailToken
= '';
1327 $this->mEmailTokenExpires
= null;
1328 $this->mRegistration
= wfTimestamp( TS_MW
);
1329 $this->mGroupMemberships
= [];
1331 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1335 * Return whether an item has been loaded.
1337 * @param string $item Item to check. Current possibilities:
1341 * @param string $all 'all' to check if the whole object has been loaded
1342 * or any other string to check if only the item is available (e.g.
1346 public function isItemLoaded( $item, $all = 'all' ) {
1347 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1348 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1352 * Set that an item has been loaded
1354 * @param string $item
1356 protected function setItemLoaded( $item ) {
1357 if ( is_array( $this->mLoadedItems
) ) {
1358 $this->mLoadedItems
[$item] = true;
1363 * Load user data from the session.
1365 * @return bool True if the user is logged in, false otherwise.
1367 private function loadFromSession() {
1370 Hooks
::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1371 if ( $result !== null ) {
1375 // MediaWiki\Session\Session already did the necessary authentication of the user
1376 // returned here, so just use it if applicable.
1377 $session = $this->getRequest()->getSession();
1378 $user = $session->getUser();
1379 if ( $user->isLoggedIn() ) {
1380 $this->loadFromUserObject( $user );
1381 if ( $user->isBlocked() ) {
1382 // If this user is autoblocked, set a cookie to track the Block. This has to be done on
1383 // every session load, because an autoblocked editor might not edit again from the same
1384 // IP address after being blocked.
1385 $this->trackBlockWithCookie();
1388 // Other code expects these to be set in the session, so set them.
1389 $session->set( 'wsUserID', $this->getId() );
1390 $session->set( 'wsUserName', $this->getName() );
1391 $session->set( 'wsToken', $this->getToken() );
1400 * Set the 'BlockID' cookie depending on block type and user authentication status.
1402 public function trackBlockWithCookie() {
1403 $block = $this->getBlock();
1404 if ( $block && $this->getRequest()->getCookie( 'BlockID' ) === null ) {
1405 $config = RequestContext
::getMain()->getConfig();
1406 $shouldSetCookie = false;
1408 if ( $this->isAnon() && $config->get( 'CookieSetOnIpBlock' ) ) {
1409 // If user is logged-out, set a cookie to track the Block
1410 $shouldSetCookie = in_array( $block->getType(), [
1411 Block
::TYPE_IP
, Block
::TYPE_RANGE
1413 if ( $shouldSetCookie ) {
1414 $block->setCookie( $this->getRequest()->response() );
1416 // temporary measure the use of cookies on ip blocks
1417 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1418 $stats->increment( 'block.ipblock.setCookie.success' );
1420 } elseif ( $this->isLoggedIn() && $config->get( 'CookieSetOnAutoblock' ) ) {
1421 $shouldSetCookie = $block->getType() === Block
::TYPE_USER
&& $block->isAutoblocking();
1422 if ( $shouldSetCookie ) {
1423 $block->setCookie( $this->getRequest()->response() );
1430 * Load user and user_group data from the database.
1431 * $this->mId must be set, this is how the user is identified.
1433 * @param int $flags User::READ_* constant bitfield
1434 * @return bool True if the user exists, false if the user is anonymous
1436 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1438 $this->mId
= intval( $this->mId
);
1440 if ( !$this->mId
) {
1441 // Anonymous users are not in the database
1442 $this->loadDefaults();
1446 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1447 $db = wfGetDB( $index );
1449 $userQuery = self
::getQueryInfo();
1450 $s = $db->selectRow(
1451 $userQuery['tables'],
1452 $userQuery['fields'],
1453 [ 'user_id' => $this->mId
],
1459 $this->queryFlagsUsed
= $flags;
1460 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1462 if ( $s !== false ) {
1463 // Initialise user table data
1464 $this->loadFromRow( $s );
1465 $this->mGroupMemberships
= null; // deferred
1466 $this->getEditCount(); // revalidation for nulls
1471 $this->loadDefaults();
1477 * Initialize this object from a row from the user table.
1479 * @param stdClass $row Row from the user table to load.
1480 * @param array|null $data Further user data to load into the object
1482 * user_groups Array of arrays or stdClass result rows out of the user_groups
1483 * table. Previously you were supposed to pass an array of strings
1484 * here, but we also need expiry info nowadays, so an array of
1485 * strings is ignored.
1486 * user_properties Array with properties out of the user_properties table
1488 protected function loadFromRow( $row, $data = null ) {
1489 global $wgActorTableSchemaMigrationStage;
1491 if ( !is_object( $row ) ) {
1492 throw new InvalidArgumentException( '$row must be an object' );
1497 $this->mGroupMemberships
= null; // deferred
1499 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
1500 // but it does little harm and might be needed for write callers loading a User.
1501 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
1502 if ( isset( $row->actor_id
) ) {
1503 $this->mActorId
= (int)$row->actor_id
;
1504 if ( $this->mActorId
!== 0 ) {
1505 $this->mFrom
= 'actor';
1507 $this->setItemLoaded( 'actor' );
1513 if ( isset( $row->user_name
) && $row->user_name
!== '' ) {
1514 $this->mName
= $row->user_name
;
1515 $this->mFrom
= 'name';
1516 $this->setItemLoaded( 'name' );
1521 if ( isset( $row->user_real_name
) ) {
1522 $this->mRealName
= $row->user_real_name
;
1523 $this->setItemLoaded( 'realname' );
1528 if ( isset( $row->user_id
) ) {
1529 $this->mId
= intval( $row->user_id
);
1530 if ( $this->mId
!== 0 ) {
1531 $this->mFrom
= 'id';
1533 $this->setItemLoaded( 'id' );
1538 if ( isset( $row->user_id
) && isset( $row->user_name
) && $row->user_name
!== '' ) {
1539 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1542 if ( isset( $row->user_editcount
) ) {
1543 $this->mEditCount
= $row->user_editcount
;
1548 if ( isset( $row->user_touched
) ) {
1549 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1554 if ( isset( $row->user_token
) ) {
1555 // The definition for the column is binary(32), so trim the NULs
1556 // that appends. The previous definition was char(32), so trim
1558 $this->mToken
= rtrim( $row->user_token
, " \0" );
1559 if ( $this->mToken
=== '' ) {
1560 $this->mToken
= null;
1566 if ( isset( $row->user_email
) ) {
1567 $this->mEmail
= $row->user_email
;
1568 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1569 $this->mEmailToken
= $row->user_email_token
;
1570 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1571 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1577 $this->mLoadedItems
= true;
1580 if ( is_array( $data ) ) {
1581 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1582 if ( !count( $data['user_groups'] ) ) {
1583 $this->mGroupMemberships
= [];
1585 $firstGroup = reset( $data['user_groups'] );
1586 if ( is_array( $firstGroup ) ||
is_object( $firstGroup ) ) {
1587 $this->mGroupMemberships
= [];
1588 foreach ( $data['user_groups'] as $row ) {
1589 $ugm = UserGroupMembership
::newFromRow( (object)$row );
1590 $this->mGroupMemberships
[$ugm->getGroup()] = $ugm;
1595 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1596 $this->loadOptions( $data['user_properties'] );
1602 * Load the data for this user object from another user object.
1606 protected function loadFromUserObject( $user ) {
1608 foreach ( self
::$mCacheVars as $var ) {
1609 $this->$var = $user->$var;
1614 * Load the groups from the database if they aren't already loaded.
1616 private function loadGroups() {
1617 if ( is_null( $this->mGroupMemberships
) ) {
1618 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1619 ?
wfGetDB( DB_MASTER
)
1620 : wfGetDB( DB_REPLICA
);
1621 $this->mGroupMemberships
= UserGroupMembership
::getMembershipsForUser(
1627 * Add the user to the group if he/she meets given criteria.
1629 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1630 * possible to remove manually via Special:UserRights. In such case it
1631 * will not be re-added automatically. The user will also not lose the
1632 * group if they no longer meet the criteria.
1634 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1636 * @return array Array of groups the user has been promoted to.
1638 * @see $wgAutopromoteOnce
1640 public function addAutopromoteOnceGroups( $event ) {
1641 global $wgAutopromoteOnceLogInRC;
1643 if ( wfReadOnly() ||
!$this->getId() ) {
1647 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1648 if ( !count( $toPromote ) ) {
1652 if ( !$this->checkAndSetTouched() ) {
1653 return []; // raced out (bug T48834)
1656 $oldGroups = $this->getGroups(); // previous groups
1657 $oldUGMs = $this->getGroupMemberships();
1658 foreach ( $toPromote as $group ) {
1659 $this->addGroup( $group );
1661 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1662 $newUGMs = $this->getGroupMemberships();
1664 // update groups in external authentication database
1665 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );
1666 AuthManager
::callLegacyAuthPlugin( 'updateExternalDBGroups', [ $this, $toPromote ] );
1668 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1669 $logEntry->setPerformer( $this );
1670 $logEntry->setTarget( $this->getUserPage() );
1671 $logEntry->setParameters( [
1672 '4::oldgroups' => $oldGroups,
1673 '5::newgroups' => $newGroups,
1675 $logid = $logEntry->insert();
1676 if ( $wgAutopromoteOnceLogInRC ) {
1677 $logEntry->publish( $logid );
1684 * Builds update conditions. Additional conditions may be added to $conditions to
1685 * protected against race conditions using a compare-and-set (CAS) mechanism
1686 * based on comparing $this->mTouched with the user_touched field.
1688 * @param Database $db
1689 * @param array $conditions WHERE conditions for use with Database::update
1690 * @return array WHERE conditions for use with Database::update
1692 protected function makeUpdateConditions( Database
$db, array $conditions ) {
1693 if ( $this->mTouched
) {
1694 // CAS check: only update if the row wasn't changed sicne it was loaded.
1695 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1702 * Bump user_touched if it didn't change since this object was loaded
1704 * On success, the mTouched field is updated.
1705 * The user serialization cache is always cleared.
1707 * @return bool Whether user_touched was actually updated
1710 protected function checkAndSetTouched() {
1713 if ( !$this->mId
) {
1714 return false; // anon
1717 // Get a new user_touched that is higher than the old one
1718 $newTouched = $this->newTouchedTimestamp();
1720 $dbw = wfGetDB( DB_MASTER
);
1721 $dbw->update( 'user',
1722 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1723 $this->makeUpdateConditions( $dbw, [
1724 'user_id' => $this->mId
,
1728 $success = ( $dbw->affectedRows() > 0 );
1731 $this->mTouched
= $newTouched;
1732 $this->clearSharedCache();
1734 // Clears on failure too since that is desired if the cache is stale
1735 $this->clearSharedCache( 'refresh' );
1742 * Clear various cached data stored in this object. The cache of the user table
1743 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1745 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1746 * given source. May be "name", "id", "actor", "defaults", "session", or false for no reload.
1748 public function clearInstanceCache( $reloadFrom = false ) {
1749 $this->mNewtalk
= -1;
1750 $this->mDatePreference
= null;
1751 $this->mBlockedby
= -1; # Unset
1752 $this->mHash
= false;
1753 $this->mRights
= null;
1754 $this->mEffectiveGroups
= null;
1755 $this->mImplicitGroups
= null;
1756 $this->mGroupMemberships
= null;
1757 $this->mOptions
= null;
1758 $this->mOptionsLoaded
= false;
1759 $this->mEditCount
= null;
1761 if ( $reloadFrom ) {
1762 $this->mLoadedItems
= [];
1763 $this->mFrom
= $reloadFrom;
1768 * Combine the language default options with any site-specific options
1769 * and add the default language variants.
1771 * @return array Array of String options
1773 public static function getDefaultOptions() {
1774 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgDefaultSkin;
1776 static $defOpt = null;
1777 static $defOptLang = null;
1779 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
1780 if ( $defOpt !== null && $defOptLang === $contLang->getCode() ) {
1781 // The content language does not change (and should not change) mid-request, but the
1782 // unit tests change it anyway, and expect this method to return values relevant to the
1783 // current content language.
1787 $defOpt = $wgDefaultUserOptions;
1788 // Default language setting
1789 $defOptLang = $contLang->getCode();
1790 $defOpt['language'] = $defOptLang;
1791 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1792 if ( $langCode === $contLang->getCode() ) {
1793 $defOpt['variant'] = $langCode;
1795 $defOpt["variant-$langCode"] = $langCode;
1799 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1800 // since extensions may change the set of searchable namespaces depending
1801 // on user groups/permissions.
1802 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1803 $defOpt['searchNs' . $nsnum] = (bool)$val;
1805 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1807 Hooks
::run( 'UserGetDefaultOptions', [ &$defOpt ] );
1813 * Get a given default option value.
1815 * @param string $opt Name of option to retrieve
1816 * @return string Default option value
1818 public static function getDefaultOption( $opt ) {
1819 $defOpts = self
::getDefaultOptions();
1820 if ( isset( $defOpts[$opt] ) ) {
1821 return $defOpts[$opt];
1828 * Get blocking information
1829 * @param bool $bFromSlave Whether to check the replica DB first.
1830 * To improve performance, non-critical checks are done against replica DBs.
1831 * Check when actually saving should be done against master.
1833 private function getBlockedStatus( $bFromSlave = true ) {
1834 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff, $wgSoftBlockRanges;
1836 if ( -1 != $this->mBlockedby
) {
1840 wfDebug( __METHOD__
. ": checking...\n" );
1842 // Initialize data...
1843 // Otherwise something ends up stomping on $this->mBlockedby when
1844 // things get lazy-loaded later, causing false positive block hits
1845 // due to -1 !== 0. Probably session-related... Nothing should be
1846 // overwriting mBlockedby, surely?
1849 # We only need to worry about passing the IP address to the Block generator if the
1850 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1851 # know which IP address they're actually coming from
1853 if ( !$this->isAllowed( 'ipblock-exempt' ) ) {
1854 // $wgUser->getName() only works after the end of Setup.php. Until
1855 // then, assume it's a logged-out user.
1856 $globalUserName = $wgUser->isSafeToLoad()
1857 ?
$wgUser->getName()
1858 : IP
::sanitizeIP( $wgUser->getRequest()->getIP() );
1859 if ( $this->getName() === $globalUserName ) {
1860 $ip = $this->getRequest()->getIP();
1865 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1868 if ( !$block instanceof Block
) {
1869 $block = $this->getBlockFromCookieValue( $this->getRequest()->getCookie( 'BlockID' ) );
1873 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1875 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1876 $block = new Block( [
1877 'byText' => wfMessage( 'proxyblocker' )->text(),
1878 'reason' => wfMessage( 'proxyblockreason' )->plain(),
1880 'systemBlock' => 'proxy',
1882 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1883 $block = new Block( [
1884 'byText' => wfMessage( 'sorbs' )->text(),
1885 'reason' => wfMessage( 'sorbsreason' )->plain(),
1887 'systemBlock' => 'dnsbl',
1892 // (T25343) Apply IP blocks to the contents of XFF headers, if enabled
1893 if ( !$block instanceof Block
1894 && $wgApplyIpBlocksToXff
1896 && !in_array( $ip, $wgProxyWhitelist )
1898 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1899 $xff = array_map( 'trim', explode( ',', $xff ) );
1900 $xff = array_diff( $xff, [ $ip ] );
1901 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1902 $block = Block
::chooseBlock( $xffblocks, $xff );
1903 if ( $block instanceof Block
) {
1904 # Mangle the reason to alert the user that the block
1905 # originated from matching the X-Forwarded-For header.
1906 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->plain();
1910 if ( !$block instanceof Block
1913 && IP
::isInRanges( $ip, $wgSoftBlockRanges )
1915 $block = new Block( [
1917 'byText' => 'MediaWiki default',
1918 'reason' => wfMessage( 'softblockrangesreason', $ip )->plain(),
1920 'systemBlock' => 'wgSoftBlockRanges',
1924 if ( $block instanceof Block
) {
1925 wfDebug( __METHOD__
. ": Found block.\n" );
1926 $this->mBlock
= $block;
1927 $this->mBlockedby
= $block->getByName();
1928 $this->mBlockreason
= $block->mReason
;
1929 $this->mHideName
= $block->mHideName
;
1930 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1932 $this->mBlock
= null;
1933 $this->mBlockedby
= '';
1934 $this->mBlockreason
= '';
1935 $this->mHideName
= 0;
1936 $this->mAllowUsertalk
= false;
1939 // Avoid PHP 7.1 warning of passing $this by reference
1942 Hooks
::run( 'GetBlockedStatus', [ &$user ] );
1946 * Try to load a Block from an ID given in a cookie value.
1947 * @param string|null $blockCookieVal The cookie value to check.
1948 * @return Block|bool The Block object, or false if none could be loaded.
1950 protected function getBlockFromCookieValue( $blockCookieVal ) {
1951 // Make sure there's something to check. The cookie value must start with a number.
1952 if ( strlen( $blockCookieVal ) < 1 ||
!is_numeric( substr( $blockCookieVal, 0, 1 ) ) ) {
1955 // Load the Block from the ID in the cookie.
1956 $blockCookieId = Block
::getIdFromCookieValue( $blockCookieVal );
1957 if ( $blockCookieId !== null ) {
1958 // An ID was found in the cookie.
1959 $tmpBlock = Block
::newFromID( $blockCookieId );
1960 if ( $tmpBlock instanceof Block
) {
1961 $config = RequestContext
::getMain()->getConfig();
1963 switch ( $tmpBlock->getType() ) {
1964 case Block
::TYPE_USER
:
1965 $blockIsValid = !$tmpBlock->isExpired() && $tmpBlock->isAutoblocking();
1966 $useBlockCookie = ( $config->get( 'CookieSetOnAutoblock' ) === true );
1968 case Block
::TYPE_IP
:
1969 case Block
::TYPE_RANGE
:
1970 // If block is type IP or IP range, load only if user is not logged in (T152462)
1971 $blockIsValid = !$tmpBlock->isExpired() && !$this->isLoggedIn();
1972 $useBlockCookie = ( $config->get( 'CookieSetOnIpBlock' ) === true );
1975 $blockIsValid = false;
1976 $useBlockCookie = false;
1979 if ( $blockIsValid && $useBlockCookie ) {
1983 // If the block is not valid, remove the cookie.
1984 Block
::clearCookie( $this->getRequest()->response() );
1987 // If the block doesn't exist, remove the cookie.
1988 Block
::clearCookie( $this->getRequest()->response() );
1995 * Whether the given IP is in a DNS blacklist.
1997 * @param string $ip IP to check
1998 * @param bool $checkWhitelist Whether to check the whitelist first
1999 * @return bool True if blacklisted.
2001 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
2002 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
2004 if ( !$wgEnableDnsBlacklist ) {
2008 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
2012 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
2016 * Whether the given IP is in a given DNS blacklist.
2018 * @param string $ip IP to check
2019 * @param string|array $bases Array of Strings: URL of the DNS blacklist
2020 * @return bool True if blacklisted.
2022 public function inDnsBlacklist( $ip, $bases ) {
2024 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
2025 if ( IP
::isIPv4( $ip ) ) {
2026 // Reverse IP, T23255
2027 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
2029 foreach ( (array)$bases as $base ) {
2031 // If we have an access key, use that too (ProjectHoneypot, etc.)
2033 if ( is_array( $base ) ) {
2034 if ( count( $base ) >= 2 ) {
2035 // Access key is 1, base URL is 0
2036 $host = "{$base[1]}.$ipReversed.{$base[0]}";
2038 $host = "$ipReversed.{$base[0]}";
2040 $basename = $base[0];
2042 $host = "$ipReversed.$base";
2046 $ipList = gethostbynamel( $host );
2049 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
2053 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
2062 * Check if an IP address is in the local proxy list
2068 public static function isLocallyBlockedProxy( $ip ) {
2069 global $wgProxyList;
2071 if ( !$wgProxyList ) {
2075 if ( !is_array( $wgProxyList ) ) {
2076 // Load values from the specified file
2077 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
2080 $resultProxyList = [];
2081 $deprecatedIPEntries = [];
2083 // backward compatibility: move all ip addresses in keys to values
2084 foreach ( $wgProxyList as $key => $value ) {
2085 $keyIsIP = IP
::isIPAddress( $key );
2086 $valueIsIP = IP
::isIPAddress( $value );
2087 if ( $keyIsIP && !$valueIsIP ) {
2088 $deprecatedIPEntries[] = $key;
2089 $resultProxyList[] = $key;
2090 } elseif ( $keyIsIP && $valueIsIP ) {
2091 $deprecatedIPEntries[] = $key;
2092 $resultProxyList[] = $key;
2093 $resultProxyList[] = $value;
2095 $resultProxyList[] = $value;
2099 if ( $deprecatedIPEntries ) {
2101 'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
2102 implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
2105 $proxyListIPSet = new IPSet( $resultProxyList );
2106 return $proxyListIPSet->match( $ip );
2110 * Is this user subject to rate limiting?
2112 * @return bool True if rate limited
2114 public function isPingLimitable() {
2115 global $wgRateLimitsExcludedIPs;
2116 if ( IP
::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
2117 // No other good way currently to disable rate limits
2118 // for specific IPs. :P
2119 // But this is a crappy hack and should die.
2122 return !$this->isAllowed( 'noratelimit' );
2126 * Primitive rate limits: enforce maximum actions per time period
2127 * to put a brake on flooding.
2129 * The method generates both a generic profiling point and a per action one
2130 * (suffix being "-$action".
2132 * @note When using a shared cache like memcached, IP-address
2133 * last-hit counters will be shared across wikis.
2135 * @param string $action Action to enforce; 'edit' if unspecified
2136 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
2137 * @return bool True if a rate limiter was tripped
2139 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
2140 // Avoid PHP 7.1 warning of passing $this by reference
2142 // Call the 'PingLimiter' hook
2144 if ( !Hooks
::run( 'PingLimiter', [ &$user, $action, &$result, $incrBy ] ) ) {
2148 global $wgRateLimits;
2149 if ( !isset( $wgRateLimits[$action] ) ) {
2153 $limits = array_merge(
2154 [ '&can-bypass' => true ],
2155 $wgRateLimits[$action]
2158 // Some groups shouldn't trigger the ping limiter, ever
2159 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
2164 $id = $this->getId();
2166 $isNewbie = $this->isNewbie();
2167 $cache = ObjectCache
::getLocalClusterInstance();
2171 if ( isset( $limits['anon'] ) ) {
2172 $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
2175 // limits for logged-in users
2176 if ( isset( $limits['user'] ) ) {
2177 $userLimit = $limits['user'];
2181 // limits for anons and for newbie logged-in users
2184 if ( isset( $limits['ip'] ) ) {
2185 $ip = $this->getRequest()->getIP();
2186 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
2188 // subnet-based limits
2189 if ( isset( $limits['subnet'] ) ) {
2190 $ip = $this->getRequest()->getIP();
2191 $subnet = IP
::getSubnet( $ip );
2192 if ( $subnet !== false ) {
2193 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
2198 // Check for group-specific permissions
2199 // If more than one group applies, use the group with the highest limit ratio (max/period)
2200 foreach ( $this->getGroups() as $group ) {
2201 if ( isset( $limits[$group] ) ) {
2202 if ( $userLimit === false
2203 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
2205 $userLimit = $limits[$group];
2210 // limits for newbie logged-in users (override all the normal user limits)
2211 if ( $id !== 0 && $isNewbie && isset( $limits['newbie'] ) ) {
2212 $userLimit = $limits['newbie'];
2215 // Set the user limit key
2216 if ( $userLimit !== false ) {
2217 list( $max, $period ) = $userLimit;
2218 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
2219 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
2222 // ip-based limits for all ping-limitable users
2223 if ( isset( $limits['ip-all'] ) ) {
2224 $ip = $this->getRequest()->getIP();
2225 // ignore if user limit is more permissive
2226 if ( $isNewbie ||
$userLimit === false
2227 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
2228 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
2232 // subnet-based limits for all ping-limitable users
2233 if ( isset( $limits['subnet-all'] ) ) {
2234 $ip = $this->getRequest()->getIP();
2235 $subnet = IP
::getSubnet( $ip );
2236 if ( $subnet !== false ) {
2237 // ignore if user limit is more permissive
2238 if ( $isNewbie ||
$userLimit === false
2239 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
2240 > $userLimit[0] / $userLimit[1] ) {
2241 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
2247 foreach ( $keys as $key => $limit ) {
2248 list( $max, $period ) = $limit;
2249 $summary = "(limit $max in {$period}s)";
2250 $count = $cache->get( $key );
2253 if ( $count >= $max ) {
2254 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
2255 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
2258 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
2261 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
2262 if ( $incrBy > 0 ) {
2263 $cache->add( $key, 0, intval( $period ) ); // first ping
2266 if ( $incrBy > 0 ) {
2267 $cache->incr( $key, $incrBy );
2275 * Check if user is blocked
2277 * @param bool $bFromSlave Whether to check the replica DB instead of
2278 * the master. Hacked from false due to horrible probs on site.
2279 * @return bool True if blocked, false otherwise
2281 public function isBlocked( $bFromSlave = true ) {
2282 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
2286 * Get the block affecting the user, or null if the user is not blocked
2288 * @param bool $bFromSlave Whether to check the replica DB instead of the master
2289 * @return Block|null
2291 public function getBlock( $bFromSlave = true ) {
2292 $this->getBlockedStatus( $bFromSlave );
2293 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
2297 * Check if user is blocked from editing a particular article
2299 * @param Title $title Title to check
2300 * @param bool $bFromSlave Whether to check the replica DB instead of the master
2303 public function isBlockedFrom( $title, $bFromSlave = false ) {
2304 global $wgBlockAllowsUTEdit;
2306 $blocked = $this->isBlocked( $bFromSlave );
2307 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
2308 // If a user's name is suppressed, they cannot make edits anywhere
2309 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName()
2310 && $title->getNamespace() == NS_USER_TALK
) {
2312 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
2315 Hooks
::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
2321 * If user is blocked, return the name of the user who placed the block
2322 * @return string Name of blocker
2324 public function blockedBy() {
2325 $this->getBlockedStatus();
2326 return $this->mBlockedby
;
2330 * If user is blocked, return the specified reason for the block
2331 * @return string Blocking reason
2333 public function blockedFor() {
2334 $this->getBlockedStatus();
2335 return $this->mBlockreason
;
2339 * If user is blocked, return the ID for the block
2340 * @return int Block ID
2342 public function getBlockId() {
2343 $this->getBlockedStatus();
2344 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2348 * Check if user is blocked on all wikis.
2349 * Do not use for actual edit permission checks!
2350 * This is intended for quick UI checks.
2352 * @param string $ip IP address, uses current client if none given
2353 * @return bool True if blocked, false otherwise
2355 public function isBlockedGlobally( $ip = '' ) {
2356 return $this->getGlobalBlock( $ip ) instanceof Block
;
2360 * Check if user is blocked on all wikis.
2361 * Do not use for actual edit permission checks!
2362 * This is intended for quick UI checks.
2364 * @param string $ip IP address, uses current client if none given
2365 * @return Block|null Block object if blocked, null otherwise
2366 * @throws FatalError
2367 * @throws MWException
2369 public function getGlobalBlock( $ip = '' ) {
2370 if ( $this->mGlobalBlock
!== null ) {
2371 return $this->mGlobalBlock ?
: null;
2373 // User is already an IP?
2374 if ( IP
::isIPAddress( $this->getName() ) ) {
2375 $ip = $this->getName();
2377 $ip = $this->getRequest()->getIP();
2379 // Avoid PHP 7.1 warning of passing $this by reference
2383 Hooks
::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
2385 if ( $blocked && $block === null ) {
2386 // back-compat: UserIsBlockedGlobally didn't have $block param first
2387 $block = new Block( [
2389 'systemBlock' => 'global-block'
2393 $this->mGlobalBlock
= $blocked ?
$block : false;
2394 return $this->mGlobalBlock ?
: null;
2398 * Check if user account is locked
2400 * @return bool True if locked, false otherwise
2402 public function isLocked() {
2403 if ( $this->mLocked
!== null ) {
2404 return $this->mLocked
;
2406 // Avoid PHP 7.1 warning of passing $this by reference
2408 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$user ], null );
2409 $this->mLocked
= $authUser && $authUser->isLocked();
2410 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2411 return $this->mLocked
;
2415 * Check if user account is hidden
2417 * @return bool True if hidden, false otherwise
2419 public function isHidden() {
2420 if ( $this->mHideName
!== null ) {
2421 return $this->mHideName
;
2423 $this->getBlockedStatus();
2424 if ( !$this->mHideName
) {
2425 // Avoid PHP 7.1 warning of passing $this by reference
2427 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$user ], null );
2428 $this->mHideName
= $authUser && $authUser->isHidden();
2429 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2431 return $this->mHideName
;
2435 * Get the user's ID.
2436 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2438 public function getId() {
2439 if ( $this->mId
=== null && $this->mName
!== null && self
::isIP( $this->mName
) ) {
2440 // Special case, we know the user is anonymous
2442 } elseif ( !$this->isItemLoaded( 'id' ) ) {
2443 // Don't load if this was initialized from an ID
2447 return (int)$this->mId
;
2451 * Set the user and reload all fields according to a given ID
2452 * @param int $v User ID to reload
2454 public function setId( $v ) {
2456 $this->clearInstanceCache( 'id' );
2460 * Get the user name, or the IP of an anonymous user
2461 * @return string User's name or IP address
2463 public function getName() {
2464 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2465 // Special case optimisation
2466 return $this->mName
;
2469 if ( $this->mName
=== false ) {
2471 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2473 return $this->mName
;
2478 * Set the user name.
2480 * This does not reload fields from the database according to the given
2481 * name. Rather, it is used to create a temporary "nonexistent user" for
2482 * later addition to the database. It can also be used to set the IP
2483 * address for an anonymous user to something other than the current
2486 * @note User::newFromName() has roughly the same function, when the named user
2488 * @param string $str New user name to set
2490 public function setName( $str ) {
2492 $this->mName
= $str;
2496 * Get the user's actor ID.
2498 * @param IDatabase|null $dbw Assign a new actor ID, using this DB handle, if none exists
2499 * @return int The actor's ID, or 0 if no actor ID exists and $dbw was null
2501 public function getActorId( IDatabase
$dbw = null ) {
2502 global $wgActorTableSchemaMigrationStage;
2504 // Technically we should always return 0 without SCHEMA_COMPAT_READ_NEW,
2505 // but it does little harm and might be needed for write callers loading a User.
2506 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) ) {
2510 if ( !$this->isItemLoaded( 'actor' ) ) {
2514 // Currently $this->mActorId might be null if $this was loaded from a
2515 // cache entry that was written when $wgActorTableSchemaMigrationStage
2516 // was SCHEMA_COMPAT_OLD. Once that is no longer a possibility (i.e. when
2517 // User::VERSION is incremented after $wgActorTableSchemaMigrationStage
2518 // has been removed), that condition may be removed.
2519 if ( $this->mActorId
=== null ||
!$this->mActorId
&& $dbw ) {
2521 'actor_user' => $this->getId() ?
: null,
2522 'actor_name' => (string)$this->getName(),
2525 if ( $q['actor_user'] === null && self
::isUsableName( $q['actor_name'] ) ) {
2526 throw new CannotCreateActorException(
2527 'Cannot create an actor for a usable name that is not an existing user'
2530 if ( $q['actor_name'] === '' ) {
2531 throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
2533 $dbw->insert( 'actor', $q, __METHOD__
, [ 'IGNORE' ] );
2534 if ( $dbw->affectedRows() ) {
2535 $this->mActorId
= (int)$dbw->insertId();
2538 list( , $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2539 $this->mActorId
= (int)$dbw->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2540 if ( !$this->mActorId
) {
2541 throw new CannotCreateActorException(
2542 "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
2546 $this->invalidateCache();
2548 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2549 $db = wfGetDB( $index );
2550 $this->mActorId
= (int)$db->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2552 $this->setItemLoaded( 'actor' );
2555 return (int)$this->mActorId
;
2559 * Get the user's name escaped by underscores.
2560 * @return string Username escaped by underscores.
2562 public function getTitleKey() {
2563 return str_replace( ' ', '_', $this->getName() );
2567 * Check if the user has new messages.
2568 * @return bool True if the user has new messages
2570 public function getNewtalk() {
2573 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2574 if ( $this->mNewtalk
=== -1 ) {
2575 $this->mNewtalk
= false; # reset talk page status
2577 // Check memcached separately for anons, who have no
2578 // entire User object stored in there.
2579 if ( !$this->mId
) {
2580 global $wgDisableAnonTalk;
2581 if ( $wgDisableAnonTalk ) {
2582 // Anon newtalk disabled by configuration.
2583 $this->mNewtalk
= false;
2585 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2588 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2592 return (bool)$this->mNewtalk
;
2596 * Return the data needed to construct links for new talk page message
2597 * alerts. If there are new messages, this will return an associative array
2598 * with the following data:
2599 * wiki: The database name of the wiki
2600 * link: Root-relative link to the user's talk page
2601 * rev: The last talk page revision that the user has seen or null. This
2602 * is useful for building diff links.
2603 * If there are no new messages, it returns an empty array.
2604 * @note This function was designed to accomodate multiple talk pages, but
2605 * currently only returns a single link and revision.
2608 public function getNewMessageLinks() {
2609 // Avoid PHP 7.1 warning of passing $this by reference
2612 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
2614 } elseif ( !$this->getNewtalk() ) {
2617 $utp = $this->getTalkPage();
2618 $dbr = wfGetDB( DB_REPLICA
);
2619 // Get the "last viewed rev" timestamp from the oldest message notification
2620 $timestamp = $dbr->selectField( 'user_newtalk',
2621 'MIN(user_last_timestamp)',
2622 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2624 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2625 return [ [ 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ] ];
2629 * Get the revision ID for the last talk page revision viewed by the talk
2631 * @return int|null Revision ID or null
2633 public function getNewMessageRevisionId() {
2634 $newMessageRevisionId = null;
2635 $newMessageLinks = $this->getNewMessageLinks();
2636 if ( $newMessageLinks ) {
2637 // Note: getNewMessageLinks() never returns more than a single link
2638 // and it is always for the same wiki, but we double-check here in
2639 // case that changes some time in the future.
2640 if ( count( $newMessageLinks ) === 1
2641 && $newMessageLinks[0]['wiki'] === wfWikiID()
2642 && $newMessageLinks[0]['rev']
2644 /** @var Revision $newMessageRevision */
2645 $newMessageRevision = $newMessageLinks[0]['rev'];
2646 $newMessageRevisionId = $newMessageRevision->getId();
2649 return $newMessageRevisionId;
2653 * Internal uncached check for new messages
2656 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2657 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2658 * @return bool True if the user has new messages
2660 protected function checkNewtalk( $field, $id ) {
2661 $dbr = wfGetDB( DB_REPLICA
);
2663 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2665 return $ok !== false;
2669 * Add or update the new messages flag
2670 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2671 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2672 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2673 * @return bool True if successful, false otherwise
2675 protected function updateNewtalk( $field, $id, $curRev = null ) {
2676 // Get timestamp of the talk page revision prior to the current one
2677 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2678 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2679 // Mark the user as having new messages since this revision
2680 $dbw = wfGetDB( DB_MASTER
);
2681 $dbw->insert( 'user_newtalk',
2682 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2685 if ( $dbw->affectedRows() ) {
2686 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2689 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2695 * Clear the new messages flag for the given user
2696 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2697 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2698 * @return bool True if successful, false otherwise
2700 protected function deleteNewtalk( $field, $id ) {
2701 $dbw = wfGetDB( DB_MASTER
);
2702 $dbw->delete( 'user_newtalk',
2705 if ( $dbw->affectedRows() ) {
2706 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2709 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2715 * Update the 'You have new messages!' status.
2716 * @param bool $val Whether the user has new messages
2717 * @param Revision|null $curRev New, as yet unseen revision of the user talk
2718 * page. Ignored if null or !$val.
2720 public function setNewtalk( $val, $curRev = null ) {
2721 if ( wfReadOnly() ) {
2726 $this->mNewtalk
= $val;
2728 if ( $this->isAnon() ) {
2730 $id = $this->getName();
2733 $id = $this->getId();
2737 $changed = $this->updateNewtalk( $field, $id, $curRev );
2739 $changed = $this->deleteNewtalk( $field, $id );
2743 $this->invalidateCache();
2748 * Generate a current or new-future timestamp to be stored in the
2749 * user_touched field when we update things.
2750 * @return string Timestamp in TS_MW format
2752 private function newTouchedTimestamp() {
2753 global $wgClockSkewFudge;
2755 $time = wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2756 if ( $this->mTouched
&& $time <= $this->mTouched
) {
2757 $time = wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2764 * Clear user data from memcached
2766 * Use after applying updates to the database; caller's
2767 * responsibility to update user_touched if appropriate.
2769 * Called implicitly from invalidateCache() and saveSettings().
2771 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2773 public function clearSharedCache( $mode = 'changed' ) {
2774 if ( !$this->getId() ) {
2778 $cache = ObjectCache
::getMainWANInstance();
2779 $key = $this->getCacheKey( $cache );
2780 if ( $mode === 'refresh' ) {
2781 $cache->delete( $key, 1 );
2783 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2784 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2785 $lb->getConnection( DB_MASTER
)->onTransactionPreCommitOrIdle(
2786 function () use ( $cache, $key ) {
2787 $cache->delete( $key );
2792 $cache->delete( $key );
2798 * Immediately touch the user data cache for this account
2800 * Calls touch() and removes account data from memcached
2802 public function invalidateCache() {
2804 $this->clearSharedCache();
2808 * Update the "touched" timestamp for the user
2810 * This is useful on various login/logout events when making sure that
2811 * a browser or proxy that has multiple tenants does not suffer cache
2812 * pollution where the new user sees the old users content. The value
2813 * of getTouched() is checked when determining 304 vs 200 responses.
2814 * Unlike invalidateCache(), this preserves the User object cache and
2815 * avoids database writes.
2819 public function touch() {
2820 $id = $this->getId();
2822 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2823 $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
2824 $cache->touchCheckKey( $key );
2825 $this->mQuickTouched
= null;
2830 * Validate the cache for this account.
2831 * @param string $timestamp A timestamp in TS_MW format
2834 public function validateCache( $timestamp ) {
2835 return ( $timestamp >= $this->getTouched() );
2839 * Get the user touched timestamp
2841 * Use this value only to validate caches via inequalities
2842 * such as in the case of HTTP If-Modified-Since response logic
2844 * @return string TS_MW Timestamp
2846 public function getTouched() {
2850 if ( $this->mQuickTouched
=== null ) {
2851 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2852 $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId
);
2854 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2857 return max( $this->mTouched
, $this->mQuickTouched
);
2860 return $this->mTouched
;
2864 * Get the user_touched timestamp field (time of last DB updates)
2865 * @return string TS_MW Timestamp
2868 public function getDBTouched() {
2871 return $this->mTouched
;
2875 * Set the password and reset the random token.
2876 * Calls through to authentication plugin if necessary;
2877 * will have no effect if the auth plugin refuses to
2878 * pass the change through or if the legal password
2881 * As a special case, setting the password to null
2882 * wipes it, so the account cannot be logged in until
2883 * a new password is set, for instance via e-mail.
2885 * @deprecated since 1.27, use AuthManager instead
2886 * @param string $str New password to set
2887 * @throws PasswordError On failure
2890 public function setPassword( $str ) {
2891 wfDeprecated( __METHOD__
, '1.27' );
2892 return $this->setPasswordInternal( $str );
2896 * Set the password and reset the random token unconditionally.
2898 * @deprecated since 1.27, use AuthManager instead
2899 * @param string|null $str New password to set or null to set an invalid
2900 * password hash meaning that the user will not be able to log in
2901 * through the web interface.
2903 public function setInternalPassword( $str ) {
2904 wfDeprecated( __METHOD__
, '1.27' );
2905 $this->setPasswordInternal( $str );
2909 * Actually set the password and such
2910 * @since 1.27 cannot set a password for a user not in the database
2911 * @param string|null $str New password to set or null to set an invalid
2912 * password hash meaning that the user will not be able to log in
2913 * through the web interface.
2914 * @return bool Success
2916 private function setPasswordInternal( $str ) {
2917 $manager = AuthManager
::singleton();
2919 // If the user doesn't exist yet, fail
2920 if ( !$manager->userExists( $this->getName() ) ) {
2921 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2924 $status = $this->changeAuthenticationData( [
2925 'username' => $this->getName(),
2929 if ( !$status->isGood() ) {
2930 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2931 ->info( __METHOD__
. ': Password change rejected: '
2932 . $status->getWikiText( null, null, 'en' ) );
2936 $this->setOption( 'watchlisttoken', false );
2937 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2943 * Changes credentials of the user.
2945 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2946 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2947 * e.g. when no provider handled the change.
2949 * @param array $data A set of authentication data in fieldname => value format. This is the
2950 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2954 public function changeAuthenticationData( array $data ) {
2955 $manager = AuthManager
::singleton();
2956 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2957 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2959 $status = Status
::newGood( 'ignored' );
2960 foreach ( $reqs as $req ) {
2961 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2963 if ( $status->getValue() === 'ignored' ) {
2964 $status->warning( 'authenticationdatachange-ignored' );
2967 if ( $status->isGood() ) {
2968 foreach ( $reqs as $req ) {
2969 $manager->changeAuthenticationData( $req );
2976 * Get the user's current token.
2977 * @param bool $forceCreation Force the generation of a new token if the
2978 * user doesn't have one (default=true for backwards compatibility).
2979 * @return string|null Token
2981 public function getToken( $forceCreation = true ) {
2982 global $wgAuthenticationTokenVersion;
2985 if ( !$this->mToken
&& $forceCreation ) {
2989 if ( !$this->mToken
) {
2990 // The user doesn't have a token, return null to indicate that.
2992 } elseif ( $this->mToken
=== self
::INVALID_TOKEN
) {
2993 // We return a random value here so existing token checks are very
2995 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2996 } elseif ( $wgAuthenticationTokenVersion === null ) {
2997 // $wgAuthenticationTokenVersion not in use, so return the raw secret
2998 return $this->mToken
;
3000 // $wgAuthenticationTokenVersion in use, so hmac it.
3001 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
3003 // The raw hash can be overly long. Shorten it up.
3004 $len = max( 32, self
::TOKEN_LENGTH
);
3005 if ( strlen( $ret ) < $len ) {
3006 // Should never happen, even md5 is 128 bits
3007 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
3009 return substr( $ret, -$len );
3014 * Set the random token (used for persistent authentication)
3015 * Called from loadDefaults() among other places.
3017 * @param string|bool $token If specified, set the token to this value
3019 public function setToken( $token = false ) {
3021 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
3022 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3023 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
3024 } elseif ( !$token ) {
3025 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3027 $this->mToken
= $token;
3032 * Set the password for a password reminder or new account email
3034 * @deprecated Removed in 1.27. Use PasswordReset instead.
3035 * @param string $str New password to set or null to set an invalid
3036 * password hash meaning that the user will not be able to use it
3037 * @param bool $throttle If true, reset the throttle timestamp to the present
3039 public function setNewpassword( $str, $throttle = true ) {
3040 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
3044 * Get the user's e-mail address
3045 * @return string User's email address
3047 public function getEmail() {
3049 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
3050 return $this->mEmail
;
3054 * Get the timestamp of the user's e-mail authentication
3055 * @return string TS_MW timestamp
3057 public function getEmailAuthenticationTimestamp() {
3059 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
3060 return $this->mEmailAuthenticated
;
3064 * Set the user's e-mail address
3065 * @param string $str New e-mail address
3067 public function setEmail( $str ) {
3069 if ( $str == $this->mEmail
) {
3072 $this->invalidateEmail();
3073 $this->mEmail
= $str;
3074 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
3078 * Set the user's e-mail address and a confirmation mail if needed.
3081 * @param string $str New e-mail address
3084 public function setEmailWithConfirmation( $str ) {
3085 global $wgEnableEmail, $wgEmailAuthentication;
3087 if ( !$wgEnableEmail ) {
3088 return Status
::newFatal( 'emaildisabled' );
3091 $oldaddr = $this->getEmail();
3092 if ( $str === $oldaddr ) {
3093 return Status
::newGood( true );
3096 $type = $oldaddr != '' ?
'changed' : 'set';
3097 $notificationResult = null;
3099 if ( $wgEmailAuthentication ) {
3100 // Send the user an email notifying the user of the change in registered
3101 // email address on their previous email address
3102 if ( $type == 'changed' ) {
3103 $change = $str != '' ?
'changed' : 'removed';
3104 $notificationResult = $this->sendMail(
3105 wfMessage( 'notificationemail_subject_' . $change )->text(),
3106 wfMessage( 'notificationemail_body_' . $change,
3107 $this->getRequest()->getIP(),
3114 $this->setEmail( $str );
3116 if ( $str !== '' && $wgEmailAuthentication ) {
3117 // Send a confirmation request to the new address if needed
3118 $result = $this->sendConfirmationMail( $type );
3120 if ( $notificationResult !== null ) {
3121 $result->merge( $notificationResult );
3124 if ( $result->isGood() ) {
3125 // Say to the caller that a confirmation and notification mail has been sent
3126 $result->value
= 'eauth';
3129 $result = Status
::newGood( true );
3136 * Get the user's real name
3137 * @return string User's real name
3139 public function getRealName() {
3140 if ( !$this->isItemLoaded( 'realname' ) ) {
3144 return $this->mRealName
;
3148 * Set the user's real name
3149 * @param string $str New real name
3151 public function setRealName( $str ) {
3153 $this->mRealName
= $str;
3157 * Get the user's current setting for a given option.
3159 * @param string $oname The option to check
3160 * @param string|array|null $defaultOverride A default value returned if the option does not exist
3161 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
3162 * @return string|array|int|null User's current value for the option
3163 * @see getBoolOption()
3164 * @see getIntOption()
3166 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
3167 global $wgHiddenPrefs;
3168 $this->loadOptions();
3170 # We want 'disabled' preferences to always behave as the default value for
3171 # users, even if they have set the option explicitly in their settings (ie they
3172 # set it, and then it was disabled removing their ability to change it). But
3173 # we don't want to erase the preferences in the database in case the preference
3174 # is re-enabled again. So don't touch $mOptions, just override the returned value
3175 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
3176 return self
::getDefaultOption( $oname );
3179 if ( array_key_exists( $oname, $this->mOptions
) ) {
3180 return $this->mOptions
[$oname];
3182 return $defaultOverride;
3187 * Get all user's options
3189 * @param int $flags Bitwise combination of:
3190 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
3191 * to the default value. (Since 1.25)
3194 public function getOptions( $flags = 0 ) {
3195 global $wgHiddenPrefs;
3196 $this->loadOptions();
3197 $options = $this->mOptions
;
3199 # We want 'disabled' preferences to always behave as the default value for
3200 # users, even if they have set the option explicitly in their settings (ie they
3201 # set it, and then it was disabled removing their ability to change it). But
3202 # we don't want to erase the preferences in the database in case the preference
3203 # is re-enabled again. So don't touch $mOptions, just override the returned value
3204 foreach ( $wgHiddenPrefs as $pref ) {
3205 $default = self
::getDefaultOption( $pref );
3206 if ( $default !== null ) {
3207 $options[$pref] = $default;
3211 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
3212 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
3219 * Get the user's current setting for a given option, as a boolean value.
3221 * @param string $oname The option to check
3222 * @return bool User's current value for the option
3225 public function getBoolOption( $oname ) {
3226 return (bool)$this->getOption( $oname );
3230 * Get the user's current setting for a given option, as an integer value.
3232 * @param string $oname The option to check
3233 * @param int $defaultOverride A default value returned if the option does not exist
3234 * @return int User's current value for the option
3237 public function getIntOption( $oname, $defaultOverride = 0 ) {
3238 $val = $this->getOption( $oname );
3240 $val = $defaultOverride;
3242 return intval( $val );
3246 * Set the given option for a user.
3248 * You need to call saveSettings() to actually write to the database.
3250 * @param string $oname The option to set
3251 * @param mixed $val New value to set
3253 public function setOption( $oname, $val ) {
3254 $this->loadOptions();
3256 // Explicitly NULL values should refer to defaults
3257 if ( is_null( $val ) ) {
3258 $val = self
::getDefaultOption( $oname );
3261 $this->mOptions
[$oname] = $val;
3265 * Get a token stored in the preferences (like the watchlist one),
3266 * resetting it if it's empty (and saving changes).
3268 * @param string $oname The option name to retrieve the token from
3269 * @return string|bool User's current value for the option, or false if this option is disabled.
3270 * @see resetTokenFromOption()
3272 * @deprecated since 1.26 Applications should use the OAuth extension
3274 public function getTokenFromOption( $oname ) {
3275 global $wgHiddenPrefs;
3277 $id = $this->getId();
3278 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
3282 $token = $this->getOption( $oname );
3284 // Default to a value based on the user token to avoid space
3285 // wasted on storing tokens for all users. When this option
3286 // is set manually by the user, only then is it stored.
3287 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
3294 * Reset a token stored in the preferences (like the watchlist one).
3295 * *Does not* save user's preferences (similarly to setOption()).
3297 * @param string $oname The option name to reset the token in
3298 * @return string|bool New token value, or false if this option is disabled.
3299 * @see getTokenFromOption()
3302 public function resetTokenFromOption( $oname ) {
3303 global $wgHiddenPrefs;
3304 if ( in_array( $oname, $wgHiddenPrefs ) ) {
3308 $token = MWCryptRand
::generateHex( 40 );
3309 $this->setOption( $oname, $token );
3314 * Return a list of the types of user options currently returned by
3315 * User::getOptionKinds().
3317 * Currently, the option kinds are:
3318 * - 'registered' - preferences which are registered in core MediaWiki or
3319 * by extensions using the UserGetDefaultOptions hook.
3320 * - 'registered-multiselect' - as above, using the 'multiselect' type.
3321 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
3322 * - 'userjs' - preferences with names starting with 'userjs-', intended to
3323 * be used by user scripts.
3324 * - 'special' - "preferences" that are not accessible via User::getOptions
3325 * or User::setOptions.
3326 * - 'unused' - preferences about which MediaWiki doesn't know anything.
3327 * These are usually legacy options, removed in newer versions.
3329 * The API (and possibly others) use this function to determine the possible
3330 * option types for validation purposes, so make sure to update this when a
3331 * new option kind is added.
3333 * @see User::getOptionKinds
3334 * @return array Option kinds
3336 public static function listOptionKinds() {
3339 'registered-multiselect',
3340 'registered-checkmatrix',
3348 * Return an associative array mapping preferences keys to the kind of a preference they're
3349 * used for. Different kinds are handled differently when setting or reading preferences.
3351 * See User::listOptionKinds for the list of valid option types that can be provided.
3353 * @see User::listOptionKinds
3354 * @param IContextSource $context
3355 * @param array|null $options Assoc. array with options keys to check as keys.
3356 * Defaults to $this->mOptions.
3357 * @return array The key => kind mapping data
3359 public function getOptionKinds( IContextSource
$context, $options = null ) {
3360 $this->loadOptions();
3361 if ( $options === null ) {
3362 $options = $this->mOptions
;
3365 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
3366 $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
3369 // Pull out the "special" options, so they don't get converted as
3370 // multiselect or checkmatrix.
3371 $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
3372 foreach ( $specialOptions as $name => $value ) {
3373 unset( $prefs[$name] );
3376 // Multiselect and checkmatrix options are stored in the database with
3377 // one key per option, each having a boolean value. Extract those keys.
3378 $multiselectOptions = [];
3379 foreach ( $prefs as $name => $info ) {
3380 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3381 ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField
::class ) ) {
3382 $opts = HTMLFormField
::flattenOptions( $info['options'] );
3383 $prefix = $info['prefix'] ??
$name;
3385 foreach ( $opts as $value ) {
3386 $multiselectOptions["$prefix$value"] = true;
3389 unset( $prefs[$name] );
3392 $checkmatrixOptions = [];
3393 foreach ( $prefs as $name => $info ) {
3394 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3395 ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix
::class ) ) {
3396 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3397 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3398 $prefix = $info['prefix'] ??
$name;
3400 foreach ( $columns as $column ) {
3401 foreach ( $rows as $row ) {
3402 $checkmatrixOptions["$prefix$column-$row"] = true;
3406 unset( $prefs[$name] );
3410 // $value is ignored
3411 foreach ( $options as $key => $value ) {
3412 if ( isset( $prefs[$key] ) ) {
3413 $mapping[$key] = 'registered';
3414 } elseif ( isset( $multiselectOptions[$key] ) ) {
3415 $mapping[$key] = 'registered-multiselect';
3416 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3417 $mapping[$key] = 'registered-checkmatrix';
3418 } elseif ( isset( $specialOptions[$key] ) ) {
3419 $mapping[$key] = 'special';
3420 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3421 $mapping[$key] = 'userjs';
3423 $mapping[$key] = 'unused';
3431 * Reset certain (or all) options to the site defaults
3433 * The optional parameter determines which kinds of preferences will be reset.
3434 * Supported values are everything that can be reported by getOptionKinds()
3435 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3437 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3438 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3439 * for backwards-compatibility.
3440 * @param IContextSource|null $context Context source used when $resetKinds
3441 * does not contain 'all', passed to getOptionKinds().
3442 * Defaults to RequestContext::getMain() when null.
3444 public function resetOptions(
3445 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3446 IContextSource
$context = null
3449 $defaultOptions = self
::getDefaultOptions();
3451 if ( !is_array( $resetKinds ) ) {
3452 $resetKinds = [ $resetKinds ];
3455 if ( in_array( 'all', $resetKinds ) ) {
3456 $newOptions = $defaultOptions;
3458 if ( $context === null ) {
3459 $context = RequestContext
::getMain();
3462 $optionKinds = $this->getOptionKinds( $context );
3463 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3466 // Use default values for the options that should be deleted, and
3467 // copy old values for the ones that shouldn't.
3468 foreach ( $this->mOptions
as $key => $value ) {
3469 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3470 if ( array_key_exists( $key, $defaultOptions ) ) {
3471 $newOptions[$key] = $defaultOptions[$key];
3474 $newOptions[$key] = $value;
3479 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3481 $this->mOptions
= $newOptions;
3482 $this->mOptionsLoaded
= true;
3486 * Get the user's preferred date format.
3487 * @return string User's preferred date format
3489 public function getDatePreference() {
3490 // Important migration for old data rows
3491 if ( is_null( $this->mDatePreference
) ) {
3493 $value = $this->getOption( 'date' );
3494 $map = $wgLang->getDatePreferenceMigrationMap();
3495 if ( isset( $map[$value] ) ) {
3496 $value = $map[$value];
3498 $this->mDatePreference
= $value;
3500 return $this->mDatePreference
;
3504 * Determine based on the wiki configuration and the user's options,
3505 * whether this user must be over HTTPS no matter what.
3509 public function requiresHTTPS() {
3510 global $wgSecureLogin;
3511 if ( !$wgSecureLogin ) {
3514 $https = $this->getBoolOption( 'prefershttps' );
3515 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3517 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3524 * Get the user preferred stub threshold
3528 public function getStubThreshold() {
3529 global $wgMaxArticleSize; # Maximum article size, in Kb
3530 $threshold = $this->getIntOption( 'stubthreshold' );
3531 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3532 // If they have set an impossible value, disable the preference
3533 // so we can use the parser cache again.
3540 * Get the permissions this user has.
3541 * @return string[] permission names
3543 public function getRights() {
3544 if ( is_null( $this->mRights
) ) {
3545 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3546 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3548 // Deny any rights denied by the user's session, unless this
3549 // endpoint has no sessions.
3550 if ( !defined( 'MW_NO_SESSION' ) ) {
3551 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3552 if ( $allowedRights !== null ) {
3553 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3557 Hooks
::run( 'UserGetRightsRemove', [ $this, &$this->mRights
] );
3558 // Force reindexation of rights when a hook has unset one of them
3559 $this->mRights
= array_values( array_unique( $this->mRights
) );
3561 // If block disables login, we should also remove any
3562 // extra rights blocked users might have, in case the
3563 // blocked user has a pre-existing session (T129738).
3564 // This is checked here for cases where people only call
3565 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3566 // to give a better error message in the common case.
3567 $config = RequestContext
::getMain()->getConfig();
3569 $this->isLoggedIn() &&
3570 $config->get( 'BlockDisablesLogin' ) &&
3574 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3577 return $this->mRights
;
3581 * Get the list of explicit group memberships this user has.
3582 * The implicit * and user groups are not included.
3583 * @return array Array of String internal group names
3585 public function getGroups() {
3587 $this->loadGroups();
3588 return array_keys( $this->mGroupMemberships
);
3592 * Get the list of explicit group memberships this user has, stored as
3593 * UserGroupMembership objects. Implicit groups are not included.
3595 * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
3598 public function getGroupMemberships() {
3600 $this->loadGroups();
3601 return $this->mGroupMemberships
;
3605 * Get the list of implicit group memberships this user has.
3606 * This includes all explicit groups, plus 'user' if logged in,
3607 * '*' for all accounts, and autopromoted groups
3608 * @param bool $recache Whether to avoid the cache
3609 * @return array Array of String internal group names
3611 public function getEffectiveGroups( $recache = false ) {
3612 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3613 $this->mEffectiveGroups
= array_unique( array_merge(
3614 $this->getGroups(), // explicit groups
3615 $this->getAutomaticGroups( $recache ) // implicit groups
3617 // Avoid PHP 7.1 warning of passing $this by reference
3619 // Hook for additional groups
3620 Hooks
::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups
] );
3621 // Force reindexation of groups when a hook has unset one of them
3622 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3624 return $this->mEffectiveGroups
;
3628 * Get the list of implicit group memberships this user has.
3629 * This includes 'user' if logged in, '*' for all accounts,
3630 * and autopromoted groups
3631 * @param bool $recache Whether to avoid the cache
3632 * @return array Array of String internal group names
3634 public function getAutomaticGroups( $recache = false ) {
3635 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3636 $this->mImplicitGroups
= [ '*' ];
3637 if ( $this->getId() ) {
3638 $this->mImplicitGroups
[] = 'user';
3640 $this->mImplicitGroups
= array_unique( array_merge(
3641 $this->mImplicitGroups
,
3642 Autopromote
::getAutopromoteGroups( $this )
3646 // Assure data consistency with rights/groups,
3647 // as getEffectiveGroups() depends on this function
3648 $this->mEffectiveGroups
= null;
3651 return $this->mImplicitGroups
;
3655 * Returns the groups the user has belonged to.
3657 * The user may still belong to the returned groups. Compare with getGroups().
3659 * The function will not return groups the user had belonged to before MW 1.17
3661 * @return array Names of the groups the user has belonged to.
3663 public function getFormerGroups() {
3666 if ( is_null( $this->mFormerGroups
) ) {
3667 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3668 ?
wfGetDB( DB_MASTER
)
3669 : wfGetDB( DB_REPLICA
);
3670 $res = $db->select( 'user_former_groups',
3672 [ 'ufg_user' => $this->mId
],
3674 $this->mFormerGroups
= [];
3675 foreach ( $res as $row ) {
3676 $this->mFormerGroups
[] = $row->ufg_group
;
3680 return $this->mFormerGroups
;
3684 * Get the user's edit count.
3685 * @return int|null Null for anonymous users
3687 public function getEditCount() {
3688 if ( !$this->getId() ) {
3692 if ( $this->mEditCount
=== null ) {
3693 /* Populate the count, if it has not been populated yet */
3694 $dbr = wfGetDB( DB_REPLICA
);
3695 // check if the user_editcount field has been initialized
3696 $count = $dbr->selectField(
3697 'user', 'user_editcount',
3698 [ 'user_id' => $this->mId
],
3702 if ( $count === null ) {
3703 // it has not been initialized. do so.
3704 $count = $this->initEditCount();
3706 $this->mEditCount
= $count;
3708 return (int)$this->mEditCount
;
3712 * Add the user to the given group. This takes immediate effect.
3713 * If the user is already in the group, the expiry time will be updated to the new
3714 * expiry time. (If $expiry is omitted or null, the membership will be altered to
3717 * @param string $group Name of the group to add
3718 * @param string|null $expiry Optional expiry timestamp in any format acceptable to
3719 * wfTimestamp(), or null if the group assignment should not expire
3722 public function addGroup( $group, $expiry = null ) {
3724 $this->loadGroups();
3727 $expiry = wfTimestamp( TS_MW
, $expiry );
3730 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
3734 // create the new UserGroupMembership and put it in the DB
3735 $ugm = new UserGroupMembership( $this->mId
, $group, $expiry );
3736 if ( !$ugm->insert( true ) ) {
3740 $this->mGroupMemberships
[$group] = $ugm;
3742 // Refresh the groups caches, and clear the rights cache so it will be
3743 // refreshed on the next call to $this->getRights().
3744 $this->getEffectiveGroups( true );
3745 $this->mRights
= null;
3747 $this->invalidateCache();
3753 * Remove the user from the given group.
3754 * This takes immediate effect.
3755 * @param string $group Name of the group to remove
3758 public function removeGroup( $group ) {
3761 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3765 $ugm = UserGroupMembership
::getMembership( $this->mId
, $group );
3766 // delete the membership entry
3767 if ( !$ugm ||
!$ugm->delete() ) {
3771 $this->loadGroups();
3772 unset( $this->mGroupMemberships
[$group] );
3774 // Refresh the groups caches, and clear the rights cache so it will be
3775 // refreshed on the next call to $this->getRights().
3776 $this->getEffectiveGroups( true );
3777 $this->mRights
= null;
3779 $this->invalidateCache();
3785 * Get whether the user is logged in
3788 public function isLoggedIn() {
3789 return $this->getId() != 0;
3793 * Get whether the user is anonymous
3796 public function isAnon() {
3797 return !$this->isLoggedIn();
3801 * @return bool Whether this user is flagged as being a bot role account
3804 public function isBot() {
3805 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3810 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3816 * Check if user is allowed to access a feature / make an action
3818 * @param string $permissions,... Permissions to test
3819 * @return bool True if user is allowed to perform *any* of the given actions
3821 public function isAllowedAny() {
3822 $permissions = func_get_args();
3823 foreach ( $permissions as $permission ) {
3824 if ( $this->isAllowed( $permission ) ) {
3833 * @param string $permissions,... Permissions to test
3834 * @return bool True if the user is allowed to perform *all* of the given actions
3836 public function isAllowedAll() {
3837 $permissions = func_get_args();
3838 foreach ( $permissions as $permission ) {
3839 if ( !$this->isAllowed( $permission ) ) {
3847 * Internal mechanics of testing a permission
3848 * @param string $action
3851 public function isAllowed( $action = '' ) {
3852 if ( $action === '' ) {
3853 return true; // In the spirit of DWIM
3855 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3856 // by misconfiguration: 0 == 'foo'
3857 return in_array( $action, $this->getRights(), true );
3861 * Check whether to enable recent changes patrol features for this user
3862 * @return bool True or false
3864 public function useRCPatrol() {
3865 global $wgUseRCPatrol;
3866 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3870 * Check whether to enable new pages patrol features for this user
3871 * @return bool True or false
3873 public function useNPPatrol() {
3874 global $wgUseRCPatrol, $wgUseNPPatrol;
3876 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3877 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3882 * Check whether to enable new files patrol features for this user
3883 * @return bool True or false
3885 public function useFilePatrol() {
3886 global $wgUseRCPatrol, $wgUseFilePatrol;
3888 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3889 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3894 * Get the WebRequest object to use with this object
3896 * @return WebRequest
3898 public function getRequest() {
3899 if ( $this->mRequest
) {
3900 return $this->mRequest
;
3908 * Check the watched status of an article.
3909 * @since 1.22 $checkRights parameter added
3910 * @param Title $title Title of the article to look at
3911 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3912 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3915 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3916 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3917 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3924 * @since 1.22 $checkRights parameter added
3925 * @param Title $title Title of the article to look at
3926 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3927 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3929 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3930 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3931 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3933 [ $title->getSubjectPage(), $title->getTalkPage() ]
3936 $this->invalidateCache();
3940 * Stop watching an article.
3941 * @since 1.22 $checkRights parameter added
3942 * @param Title $title Title of the article to look at
3943 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3944 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3946 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3947 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3948 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3949 $store->removeWatch( $this, $title->getSubjectPage() );
3950 $store->removeWatch( $this, $title->getTalkPage() );
3952 $this->invalidateCache();
3956 * Clear the user's notification timestamp for the given title.
3957 * If e-notif e-mails are on, they will receive notification mails on
3958 * the next change of the page if it's watched etc.
3959 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3960 * @param Title &$title Title of the article to look at
3961 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3963 public function clearNotification( &$title, $oldid = 0 ) {
3964 global $wgUseEnotif, $wgShowUpdatedMarker;
3966 // Do nothing if the database is locked to writes
3967 if ( wfReadOnly() ) {
3971 // Do nothing if not allowed to edit the watchlist
3972 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3976 // If we're working on user's talk page, we should update the talk page message indicator
3977 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3978 // Avoid PHP 7.1 warning of passing $this by reference
3980 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
3984 // Try to update the DB post-send and only if needed...
3985 DeferredUpdates
::addCallableUpdate( function () use ( $title, $oldid ) {
3986 if ( !$this->getNewtalk() ) {
3987 return; // no notifications to clear
3990 // Delete the last notifications (they stack up)
3991 $this->setNewtalk( false );
3993 // If there is a new, unseen, revision, use its timestamp
3995 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
3998 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
4003 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4007 if ( $this->isAnon() ) {
4008 // Nothing else to do...
4012 // Only update the timestamp if the page is being watched.
4013 // The query to find out if it is watched is cached both in memcached and per-invocation,
4014 // and when it does have to be executed, it can be on a replica DB
4015 // If this is the user's newtalk page, we always update the timestamp
4017 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
4021 MediaWikiServices
::getInstance()->getWatchedItemStore()
4022 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
4026 * Resets all of the given user's page-change notification timestamps.
4027 * If e-notif e-mails are on, they will receive notification mails on
4028 * the next change of any watched page.
4029 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
4031 public function clearAllNotifications() {
4032 global $wgUseEnotif, $wgShowUpdatedMarker;
4033 // Do nothing if not allowed to edit the watchlist
4034 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
4038 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4039 $this->setNewtalk( false );
4043 $id = $this->getId();
4048 $watchedItemStore = MediaWikiServices
::getInstance()->getWatchedItemStore();
4049 $watchedItemStore->resetAllNotificationTimestampsForUser( $this );
4051 // We also need to clear here the "you have new message" notification for the own
4052 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
4056 * Compute experienced level based on edit count and registration date.
4058 * @return string 'newcomer', 'learner', or 'experienced'
4060 public function getExperienceLevel() {
4061 global $wgLearnerEdits,
4062 $wgExperiencedUserEdits,
4063 $wgLearnerMemberSince,
4064 $wgExperiencedUserMemberSince;
4066 if ( $this->isAnon() ) {
4070 $editCount = $this->getEditCount();
4071 $registration = $this->getRegistration();
4073 $learnerRegistration = wfTimestamp( TS_MW
, $now - $wgLearnerMemberSince * 86400 );
4074 $experiencedRegistration = wfTimestamp( TS_MW
, $now - $wgExperiencedUserMemberSince * 86400 );
4077 $editCount < $wgLearnerEdits ||
4078 $registration > $learnerRegistration
4082 $editCount > $wgExperiencedUserEdits &&
4083 $registration <= $experiencedRegistration
4085 return 'experienced';
4092 * Persist this user's session (e.g. set cookies)
4094 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
4096 * @param bool|null $secure Whether to force secure/insecure cookies or use default
4097 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
4099 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
4101 if ( 0 == $this->mId
) {
4105 $session = $this->getRequest()->getSession();
4106 if ( $request && $session->getRequest() !== $request ) {
4107 $session = $session->sessionWithRequest( $request );
4109 $delay = $session->delaySave();
4111 if ( !$session->getUser()->equals( $this ) ) {
4112 if ( !$session->canSetUser() ) {
4113 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4114 ->warning( __METHOD__
.
4115 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
4119 $session->setUser( $this );
4122 $session->setRememberUser( $rememberMe );
4123 if ( $secure !== null ) {
4124 $session->setForceHTTPS( $secure );
4127 $session->persist();
4129 ScopedCallback
::consume( $delay );
4133 * Log this user out.
4135 public function logout() {
4136 // Avoid PHP 7.1 warning of passing $this by reference
4138 if ( Hooks
::run( 'UserLogout', [ &$user ] ) ) {
4144 * Clear the user's session, and reset the instance cache.
4147 public function doLogout() {
4148 $session = $this->getRequest()->getSession();
4149 if ( !$session->canSetUser() ) {
4150 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4151 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
4152 $error = 'immutable';
4153 } elseif ( !$session->getUser()->equals( $this ) ) {
4154 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4155 ->warning( __METHOD__
.
4156 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
4158 // But we still may as well make this user object anon
4159 $this->clearInstanceCache( 'defaults' );
4160 $error = 'wronguser';
4162 $this->clearInstanceCache( 'defaults' );
4163 $delay = $session->delaySave();
4164 $session->unpersist(); // Clear cookies (T127436)
4165 $session->setLoggedOutTimestamp( time() );
4166 $session->setUser( new User
);
4167 $session->set( 'wsUserID', 0 ); // Other code expects this
4168 $session->resetAllTokens();
4169 ScopedCallback
::consume( $delay );
4172 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
4173 'event' => 'logout',
4174 'successful' => $error === false,
4175 'status' => $error ?
: 'success',
4180 * Save this user's settings into the database.
4181 * @todo Only rarely do all these fields need to be set!
4183 public function saveSettings() {
4184 if ( wfReadOnly() ) {
4185 // @TODO: caller should deal with this instead!
4186 // This should really just be an exception.
4187 MWExceptionHandler
::logException( new DBExpectedError(
4189 "Could not update user with ID '{$this->mId}'; DB is read-only."
4195 if ( 0 == $this->mId
) {
4199 // Get a new user_touched that is higher than the old one.
4200 // This will be used for a CAS check as a last-resort safety
4201 // check against race conditions and replica DB lag.
4202 $newTouched = $this->newTouchedTimestamp();
4204 $dbw = wfGetDB( DB_MASTER
);
4205 $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $newTouched ) {
4206 global $wgActorTableSchemaMigrationStage;
4208 $dbw->update( 'user',
4210 'user_name' => $this->mName
,
4211 'user_real_name' => $this->mRealName
,
4212 'user_email' => $this->mEmail
,
4213 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4214 'user_touched' => $dbw->timestamp( $newTouched ),
4215 'user_token' => strval( $this->mToken
),
4216 'user_email_token' => $this->mEmailToken
,
4217 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
4218 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
4219 'user_id' => $this->mId
,
4223 if ( !$dbw->affectedRows() ) {
4224 // Maybe the problem was a missed cache update; clear it to be safe
4225 $this->clearSharedCache( 'refresh' );
4226 // User was changed in the meantime or loaded with stale data
4227 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
4228 LoggerFactory
::getInstance( 'preferences' )->warning(
4229 "CAS update failed on user_touched for user ID '{user_id}' ({db_flag} read)",
4230 [ 'user_id' => $this->mId
, 'db_flag' => $from ]
4232 throw new MWException( "CAS update failed on user_touched. " .
4233 "The version of the user to be saved is older than the current version."
4237 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4240 [ 'actor_name' => $this->mName
],
4241 [ 'actor_user' => $this->mId
],
4247 $this->mTouched
= $newTouched;
4248 $this->saveOptions();
4250 Hooks
::run( 'UserSaveSettings', [ $this ] );
4251 $this->clearSharedCache();
4252 $this->getUserPage()->invalidateCache();
4256 * If only this user's username is known, and it exists, return the user ID.
4258 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
4261 public function idForName( $flags = 0 ) {
4262 $s = trim( $this->getName() );
4267 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
4268 ?
wfGetDB( DB_MASTER
)
4269 : wfGetDB( DB_REPLICA
);
4271 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
4272 ?
[ 'LOCK IN SHARE MODE' ]
4275 $id = $db->selectField( 'user',
4276 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
4282 * Add a user to the database, return the user object
4284 * @param string $name Username to add
4285 * @param array $params Array of Strings Non-default parameters to save to
4286 * the database as user_* fields:
4287 * - email: The user's email address.
4288 * - email_authenticated: The email authentication timestamp.
4289 * - real_name: The user's real name.
4290 * - options: An associative array of non-default options.
4291 * - token: Random authentication token. Do not set.
4292 * - registration: Registration timestamp. Do not set.
4294 * @return User|null User object, or null if the username already exists.
4296 public static function createNew( $name, $params = [] ) {
4297 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
4298 if ( isset( $params[$field] ) ) {
4299 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
4300 unset( $params[$field] );
4306 $user->setToken(); // init token
4307 if ( isset( $params['options'] ) ) {
4308 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
4309 unset( $params['options'] );
4311 $dbw = wfGetDB( DB_MASTER
);
4313 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4316 'user_name' => $name,
4317 'user_password' => $noPass,
4318 'user_newpassword' => $noPass,
4319 'user_email' => $user->mEmail
,
4320 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
4321 'user_real_name' => $user->mRealName
,
4322 'user_token' => strval( $user->mToken
),
4323 'user_registration' => $dbw->timestamp( $user->mRegistration
),
4324 'user_editcount' => 0,
4325 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4327 foreach ( $params as $name => $value ) {
4328 $fields["user_$name"] = $value;
4331 return $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $fields ) {
4332 $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
4333 if ( $dbw->affectedRows() ) {
4334 $newUser = self
::newFromId( $dbw->insertId() );
4335 $newUser->mName
= $fields['user_name'];
4336 $newUser->updateActorId( $dbw );
4337 // Load the user from master to avoid replica lag
4338 $newUser->load( self
::READ_LATEST
);
4347 * Add this existing user object to the database. If the user already
4348 * exists, a fatal status object is returned, and the user object is
4349 * initialised with the data from the database.
4351 * Previously, this function generated a DB error due to a key conflict
4352 * if the user already existed. Many extension callers use this function
4353 * in code along the lines of:
4355 * $user = User::newFromName( $name );
4356 * if ( !$user->isLoggedIn() ) {
4357 * $user->addToDatabase();
4359 * // do something with $user...
4361 * However, this was vulnerable to a race condition (T18020). By
4362 * initialising the user object if the user exists, we aim to support this
4363 * calling sequence as far as possible.
4365 * Note that if the user exists, this function will acquire a write lock,
4366 * so it is still advisable to make the call conditional on isLoggedIn(),
4367 * and to commit the transaction after calling.
4369 * @throws MWException
4372 public function addToDatabase() {
4374 if ( !$this->mToken
) {
4375 $this->setToken(); // init token
4378 if ( !is_string( $this->mName
) ) {
4379 throw new RuntimeException( "User name field is not set." );
4382 $this->mTouched
= $this->newTouchedTimestamp();
4384 $dbw = wfGetDB( DB_MASTER
);
4385 $status = $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) {
4386 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4387 $dbw->insert( 'user',
4389 'user_name' => $this->mName
,
4390 'user_password' => $noPass,
4391 'user_newpassword' => $noPass,
4392 'user_email' => $this->mEmail
,
4393 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4394 'user_real_name' => $this->mRealName
,
4395 'user_token' => strval( $this->mToken
),
4396 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4397 'user_editcount' => 0,
4398 'user_touched' => $dbw->timestamp( $this->mTouched
),
4402 if ( !$dbw->affectedRows() ) {
4403 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4404 $this->mId
= $dbw->selectField(
4407 [ 'user_name' => $this->mName
],
4409 [ 'LOCK IN SHARE MODE' ]
4413 if ( $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4418 throw new MWException( $fname . ": hit a key conflict attempting " .
4419 "to insert user '{$this->mName}' row, but it was not present in select!" );
4421 return Status
::newFatal( 'userexists' );
4423 $this->mId
= $dbw->insertId();
4424 self
::$idCacheByName[$this->mName
] = $this->mId
;
4425 $this->updateActorId( $dbw );
4427 return Status
::newGood();
4429 if ( !$status->isGood() ) {
4433 // Clear instance cache other than user table data and actor, which is already accurate
4434 $this->clearInstanceCache();
4436 $this->saveOptions();
4437 return Status
::newGood();
4441 * Update the actor ID after an insert
4442 * @param IDatabase $dbw Writable database handle
4444 private function updateActorId( IDatabase
$dbw ) {
4445 global $wgActorTableSchemaMigrationStage;
4447 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4450 [ 'actor_user' => $this->mId
, 'actor_name' => $this->mName
],
4453 $this->mActorId
= (int)$dbw->insertId();
4458 * If this user is logged-in and blocked,
4459 * block any IP address they've successfully logged in from.
4460 * @return bool A block was spread
4462 public function spreadAnyEditBlock() {
4463 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4464 return $this->spreadBlock();
4471 * If this (non-anonymous) user is blocked,
4472 * block the IP address they've successfully logged in from.
4473 * @return bool A block was spread
4475 protected function spreadBlock() {
4476 wfDebug( __METHOD__
. "()\n" );
4478 if ( $this->mId
== 0 ) {
4482 $userblock = Block
::newFromTarget( $this->getName() );
4483 if ( !$userblock ) {
4487 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4491 * Get whether the user is explicitly blocked from account creation.
4492 * @return bool|Block
4494 public function isBlockedFromCreateAccount() {
4495 $this->getBlockedStatus();
4496 if ( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
4497 return $this->mBlock
;
4500 # T15611: if the IP address the user is trying to create an account from is
4501 # blocked with createaccount disabled, prevent new account creation there even
4502 # when the user is logged in
4503 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4504 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4506 return $this->mBlockedFromCreateAccount
instanceof Block
4507 && $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
4508 ?
$this->mBlockedFromCreateAccount
4513 * Get whether the user is blocked from using Special:Emailuser.
4516 public function isBlockedFromEmailuser() {
4517 $this->getBlockedStatus();
4518 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
4522 * Get whether the user is allowed to create an account.
4525 public function isAllowedToCreateAccount() {
4526 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4530 * Get this user's personal page title.
4532 * @return Title User's personal page title
4534 public function getUserPage() {
4535 return Title
::makeTitle( NS_USER
, $this->getName() );
4539 * Get this user's talk page title.
4541 * @return Title User's talk page title
4543 public function getTalkPage() {
4544 $title = $this->getUserPage();
4545 return $title->getTalkPage();
4549 * Determine whether the user is a newbie. Newbies are either
4550 * anonymous IPs, or the most recently created accounts.
4553 public function isNewbie() {
4554 return !$this->isAllowed( 'autoconfirmed' );
4558 * Check to see if the given clear-text password is one of the accepted passwords
4559 * @deprecated since 1.27, use AuthManager instead
4560 * @param string $password User password
4561 * @return bool True if the given password is correct, otherwise False
4563 public function checkPassword( $password ) {
4564 wfDeprecated( __METHOD__
, '1.27' );
4566 $manager = AuthManager
::singleton();
4567 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4568 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4570 'username' => $this->getName(),
4571 'password' => $password,
4574 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4575 switch ( $res->status
) {
4576 case AuthenticationResponse
::PASS
:
4578 case AuthenticationResponse
::FAIL
:
4579 // Hope it's not a PreAuthenticationProvider that failed...
4580 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4581 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4584 throw new BadMethodCallException(
4585 'AuthManager returned a response unsupported by ' . __METHOD__
4591 * Check if the given clear-text password matches the temporary password
4592 * sent by e-mail for password reset operations.
4594 * @deprecated since 1.27, use AuthManager instead
4595 * @param string $plaintext
4596 * @return bool True if matches, false otherwise
4598 public function checkTemporaryPassword( $plaintext ) {
4599 wfDeprecated( __METHOD__
, '1.27' );
4600 // Can't check the temporary password individually.
4601 return $this->checkPassword( $plaintext );
4605 * Initialize (if necessary) and return a session token value
4606 * which can be used in edit forms to show that the user's
4607 * login credentials aren't being hijacked with a foreign form
4611 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4612 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4613 * @return MediaWiki\Session\Token The new edit token
4615 public function getEditTokenObject( $salt = '', $request = null ) {
4616 if ( $this->isAnon() ) {
4617 return new LoggedOutEditToken();
4621 $request = $this->getRequest();
4623 return $request->getSession()->getToken( $salt );
4627 * Initialize (if necessary) and return a session token value
4628 * which can be used in edit forms to show that the user's
4629 * login credentials aren't being hijacked with a foreign form
4632 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4635 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4636 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4637 * @return string The new edit token
4639 public function getEditToken( $salt = '', $request = null ) {
4640 return $this->getEditTokenObject( $salt, $request )->toString();
4644 * Check given value against the token value stored in the session.
4645 * A match should confirm that the form was submitted from the
4646 * user's own login session, not a form submission from a third-party
4649 * @param string $val Input value to compare
4650 * @param string|array $salt Optional function-specific data for hashing
4651 * @param WebRequest|null $request Object to use or null to use $wgRequest
4652 * @param int|null $maxage Fail tokens older than this, in seconds
4653 * @return bool Whether the token matches
4655 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4656 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4660 * Check given value against the token value stored in the session,
4661 * ignoring the suffix.
4663 * @param string $val Input value to compare
4664 * @param string|array $salt Optional function-specific data for hashing
4665 * @param WebRequest|null $request Object to use or null to use $wgRequest
4666 * @param int|null $maxage Fail tokens older than this, in seconds
4667 * @return bool Whether the token matches
4669 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4670 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4671 return $this->matchEditToken( $val, $salt, $request, $maxage );
4675 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4676 * mail to the user's given address.
4678 * @param string $type Message to send, either "created", "changed" or "set"
4681 public function sendConfirmationMail( $type = 'created' ) {
4683 $expiration = null; // gets passed-by-ref and defined in next line.
4684 $token = $this->confirmationToken( $expiration );
4685 $url = $this->confirmationTokenUrl( $token );
4686 $invalidateURL = $this->invalidationTokenUrl( $token );
4687 $this->saveSettings();
4689 if ( $type == 'created' ||
$type === false ) {
4690 $message = 'confirmemail_body';
4691 } elseif ( $type === true ) {
4692 $message = 'confirmemail_body_changed';
4694 // Messages: confirmemail_body_changed, confirmemail_body_set
4695 $message = 'confirmemail_body_' . $type;
4698 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4699 wfMessage( $message,
4700 $this->getRequest()->getIP(),
4703 $wgLang->userTimeAndDate( $expiration, $this ),
4705 $wgLang->userDate( $expiration, $this ),
4706 $wgLang->userTime( $expiration, $this ) )->text() );
4710 * Send an e-mail to this user's account. Does not check for
4711 * confirmed status or validity.
4713 * @param string $subject Message subject
4714 * @param string $body Message body
4715 * @param User|null $from Optional sending user; if unspecified, default
4716 * $wgPasswordSender will be used.
4717 * @param string|null $replyto Reply-To address
4720 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4721 global $wgPasswordSender;
4723 if ( $from instanceof User
) {
4724 $sender = MailAddress
::newFromUser( $from );
4726 $sender = new MailAddress( $wgPasswordSender,
4727 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4729 $to = MailAddress
::newFromUser( $this );
4731 return UserMailer
::send( $to, $sender, $subject, $body, [
4732 'replyTo' => $replyto,
4737 * Generate, store, and return a new e-mail confirmation code.
4738 * A hash (unsalted, since it's used as a key) is stored.
4740 * @note Call saveSettings() after calling this function to commit
4741 * this change to the database.
4743 * @param string &$expiration Accepts the expiration time
4744 * @return string New token
4746 protected function confirmationToken( &$expiration ) {
4747 global $wgUserEmailConfirmationTokenExpiry;
4749 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4750 $expiration = wfTimestamp( TS_MW
, $expires );
4752 $token = MWCryptRand
::generateHex( 32 );
4753 $hash = md5( $token );
4754 $this->mEmailToken
= $hash;
4755 $this->mEmailTokenExpires
= $expiration;
4760 * Return a URL the user can use to confirm their email address.
4761 * @param string $token Accepts the email confirmation token
4762 * @return string New token URL
4764 protected function confirmationTokenUrl( $token ) {
4765 return $this->getTokenUrl( 'ConfirmEmail', $token );
4769 * Return a URL the user can use to invalidate their email address.
4770 * @param string $token Accepts the email confirmation token
4771 * @return string New token URL
4773 protected function invalidationTokenUrl( $token ) {
4774 return $this->getTokenUrl( 'InvalidateEmail', $token );
4778 * Internal function to format the e-mail validation/invalidation URLs.
4779 * This uses a quickie hack to use the
4780 * hardcoded English names of the Special: pages, for ASCII safety.
4782 * @note Since these URLs get dropped directly into emails, using the
4783 * short English names avoids insanely long URL-encoded links, which
4784 * also sometimes can get corrupted in some browsers/mailers
4785 * (T8957 with Gmail and Internet Explorer).
4787 * @param string $page Special page
4788 * @param string $token
4789 * @return string Formatted URL
4791 protected function getTokenUrl( $page, $token ) {
4792 // Hack to bypass localization of 'Special:'
4793 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4794 return $title->getCanonicalURL();
4798 * Mark the e-mail address confirmed.
4800 * @note Call saveSettings() after calling this function to commit the change.
4804 public function confirmEmail() {
4805 // Check if it's already confirmed, so we don't touch the database
4806 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4807 if ( !$this->isEmailConfirmed() ) {
4808 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4809 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4815 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4816 * address if it was already confirmed.
4818 * @note Call saveSettings() after calling this function to commit the change.
4819 * @return bool Returns true
4821 public function invalidateEmail() {
4823 $this->mEmailToken
= null;
4824 $this->mEmailTokenExpires
= null;
4825 $this->setEmailAuthenticationTimestamp( null );
4827 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4832 * Set the e-mail authentication timestamp.
4833 * @param string $timestamp TS_MW timestamp
4835 public function setEmailAuthenticationTimestamp( $timestamp ) {
4837 $this->mEmailAuthenticated
= $timestamp;
4838 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4842 * Is this user allowed to send e-mails within limits of current
4843 * site configuration?
4846 public function canSendEmail() {
4847 global $wgEnableEmail, $wgEnableUserEmail;
4848 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4851 $canSend = $this->isEmailConfirmed();
4852 // Avoid PHP 7.1 warning of passing $this by reference
4854 Hooks
::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
4859 * Is this user allowed to receive e-mails within limits of current
4860 * site configuration?
4863 public function canReceiveEmail() {
4864 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4868 * Is this user's e-mail address valid-looking and confirmed within
4869 * limits of the current site configuration?
4871 * @note If $wgEmailAuthentication is on, this may require the user to have
4872 * confirmed their address by returning a code or using a password
4873 * sent to the address from the wiki.
4877 public function isEmailConfirmed() {
4878 global $wgEmailAuthentication;
4880 // Avoid PHP 7.1 warning of passing $this by reference
4883 if ( Hooks
::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
4884 if ( $this->isAnon() ) {
4887 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4890 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4900 * Check whether there is an outstanding request for e-mail confirmation.
4903 public function isEmailConfirmationPending() {
4904 global $wgEmailAuthentication;
4905 return $wgEmailAuthentication &&
4906 !$this->isEmailConfirmed() &&
4907 $this->mEmailToken
&&
4908 $this->mEmailTokenExpires
> wfTimestamp();
4912 * Get the timestamp of account creation.
4914 * @return string|bool|null Timestamp of account creation, false for
4915 * non-existent/anonymous user accounts, or null if existing account
4916 * but information is not in database.
4918 public function getRegistration() {
4919 if ( $this->isAnon() ) {
4923 return $this->mRegistration
;
4927 * Get the timestamp of the first edit
4929 * @return string|bool Timestamp of first edit, or false for
4930 * non-existent/anonymous user accounts.
4932 public function getFirstEditTimestamp() {
4933 if ( $this->getId() == 0 ) {
4934 return false; // anons
4936 $dbr = wfGetDB( DB_REPLICA
);
4937 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
4938 $time = $dbr->selectField(
4939 [ 'revision' ] +
$actorWhere['tables'],
4941 [ $actorWhere['conds'] ],
4943 [ 'ORDER BY' => 'rev_timestamp ASC' ],
4944 $actorWhere['joins']
4947 return false; // no edits
4949 return wfTimestamp( TS_MW
, $time );
4953 * Get the permissions associated with a given list of groups
4955 * @param array $groups Array of Strings List of internal group names
4956 * @return array Array of Strings List of permission key names for given groups combined
4958 public static function getGroupPermissions( $groups ) {
4959 global $wgGroupPermissions, $wgRevokePermissions;
4961 // grant every granted permission first
4962 foreach ( $groups as $group ) {
4963 if ( isset( $wgGroupPermissions[$group] ) ) {
4964 $rights = array_merge( $rights,
4965 // array_filter removes empty items
4966 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4969 // now revoke the revoked permissions
4970 foreach ( $groups as $group ) {
4971 if ( isset( $wgRevokePermissions[$group] ) ) {
4972 $rights = array_diff( $rights,
4973 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4976 return array_unique( $rights );
4980 * Get all the groups who have a given permission
4982 * @param string $role Role to check
4983 * @return array Array of Strings List of internal group names with the given permission
4985 public static function getGroupsWithPermission( $role ) {
4986 global $wgGroupPermissions;
4987 $allowedGroups = [];
4988 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4989 if ( self
::groupHasPermission( $group, $role ) ) {
4990 $allowedGroups[] = $group;
4993 return $allowedGroups;
4997 * Check, if the given group has the given permission
4999 * If you're wanting to check whether all users have a permission, use
5000 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
5004 * @param string $group Group to check
5005 * @param string $role Role to check
5008 public static function groupHasPermission( $group, $role ) {
5009 global $wgGroupPermissions, $wgRevokePermissions;
5010 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
5011 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
5015 * Check if all users may be assumed to have the given permission
5017 * We generally assume so if the right is granted to '*' and isn't revoked
5018 * on any group. It doesn't attempt to take grants or other extension
5019 * limitations on rights into account in the general case, though, as that
5020 * would require it to always return false and defeat the purpose.
5021 * Specifically, session-based rights restrictions (such as OAuth or bot
5022 * passwords) are applied based on the current session.
5025 * @param string $right Right to check
5028 public static function isEveryoneAllowed( $right ) {
5029 global $wgGroupPermissions, $wgRevokePermissions;
5032 // Use the cached results, except in unit tests which rely on
5033 // being able change the permission mid-request
5034 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
5035 return $cache[$right];
5038 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
5039 $cache[$right] = false;
5043 // If it's revoked anywhere, then everyone doesn't have it
5044 foreach ( $wgRevokePermissions as $rights ) {
5045 if ( isset( $rights[$right] ) && $rights[$right] ) {
5046 $cache[$right] = false;
5051 // Remove any rights that aren't allowed to the global-session user,
5052 // unless there are no sessions for this endpoint.
5053 if ( !defined( 'MW_NO_SESSION' ) ) {
5054 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
5055 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
5056 $cache[$right] = false;
5061 // Allow extensions to say false
5062 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
5063 $cache[$right] = false;
5067 $cache[$right] = true;
5072 * Get the localized descriptive name for a group, if it exists
5073 * @deprecated since 1.29 Use UserGroupMembership::getGroupName instead
5075 * @param string $group Internal group name
5076 * @return string Localized descriptive group name
5078 public static function getGroupName( $group ) {
5079 wfDeprecated( __METHOD__
, '1.29' );
5080 return UserGroupMembership
::getGroupName( $group );
5084 * Get the localized descriptive name for a member of a group, if it exists
5085 * @deprecated since 1.29 Use UserGroupMembership::getGroupMemberName instead
5087 * @param string $group Internal group name
5088 * @param string $username Username for gender (since 1.19)
5089 * @return string Localized name for group member
5091 public static function getGroupMember( $group, $username = '#' ) {
5092 wfDeprecated( __METHOD__
, '1.29' );
5093 return UserGroupMembership
::getGroupMemberName( $group, $username );
5097 * Return the set of defined explicit groups.
5098 * The implicit groups (by default *, 'user' and 'autoconfirmed')
5099 * are not included, as they are defined automatically, not in the database.
5100 * @return array Array of internal group names
5102 public static function getAllGroups() {
5103 global $wgGroupPermissions, $wgRevokePermissions;
5104 return array_values( array_diff(
5105 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
5106 self
::getImplicitGroups()
5111 * Get a list of all available permissions.
5112 * @return string[] Array of permission names
5114 public static function getAllRights() {
5115 if ( self
::$mAllRights === false ) {
5116 global $wgAvailableRights;
5117 if ( count( $wgAvailableRights ) ) {
5118 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
5120 self
::$mAllRights = self
::$mCoreRights;
5122 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
5124 return self
::$mAllRights;
5128 * Get a list of implicit groups
5129 * TODO: Should we deprecate this? It's trivial, but we don't want to encourage use of globals.
5131 * @return array Array of Strings Array of internal group names
5133 public static function getImplicitGroups() {
5134 global $wgImplicitGroups;
5135 return $wgImplicitGroups;
5139 * Get the title of a page describing a particular group
5140 * @deprecated since 1.29 Use UserGroupMembership::getGroupPage instead
5142 * @param string $group Internal group name
5143 * @return Title|bool Title of the page if it exists, false otherwise
5145 public static function getGroupPage( $group ) {
5146 wfDeprecated( __METHOD__
, '1.29' );
5147 return UserGroupMembership
::getGroupPage( $group );
5151 * Create a link to the group in HTML, if available;
5152 * else return the group name.
5153 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5154 * make the link yourself if you need custom text
5156 * @param string $group Internal name of the group
5157 * @param string $text The text of the link
5158 * @return string HTML link to the group
5160 public static function makeGroupLinkHTML( $group, $text = '' ) {
5161 wfDeprecated( __METHOD__
, '1.29' );
5163 if ( $text == '' ) {
5164 $text = UserGroupMembership
::getGroupName( $group );
5166 $title = UserGroupMembership
::getGroupPage( $group );
5168 return MediaWikiServices
::getInstance()
5169 ->getLinkRenderer()->makeLink( $title, $text );
5171 return htmlspecialchars( $text );
5176 * Create a link to the group in Wikitext, if available;
5177 * else return the group name.
5178 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5179 * make the link yourself if you need custom text
5181 * @param string $group Internal name of the group
5182 * @param string $text The text of the link
5183 * @return string Wikilink to the group
5185 public static function makeGroupLinkWiki( $group, $text = '' ) {
5186 wfDeprecated( __METHOD__
, '1.29' );
5188 if ( $text == '' ) {
5189 $text = UserGroupMembership
::getGroupName( $group );
5191 $title = UserGroupMembership
::getGroupPage( $group );
5193 $page = $title->getFullText();
5194 return "[[$page|$text]]";
5201 * Returns an array of the groups that a particular group can add/remove.
5203 * @param string $group The group to check for whether it can add/remove
5204 * @return array Array( 'add' => array( addablegroups ),
5205 * 'remove' => array( removablegroups ),
5206 * 'add-self' => array( addablegroups to self),
5207 * 'remove-self' => array( removable groups from self) )
5209 public static function changeableByGroup( $group ) {
5210 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
5219 if ( empty( $wgAddGroups[$group] ) ) {
5220 // Don't add anything to $groups
5221 } elseif ( $wgAddGroups[$group] === true ) {
5222 // You get everything
5223 $groups['add'] = self
::getAllGroups();
5224 } elseif ( is_array( $wgAddGroups[$group] ) ) {
5225 $groups['add'] = $wgAddGroups[$group];
5228 // Same thing for remove
5229 if ( empty( $wgRemoveGroups[$group] ) ) {
5231 } elseif ( $wgRemoveGroups[$group] === true ) {
5232 $groups['remove'] = self
::getAllGroups();
5233 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
5234 $groups['remove'] = $wgRemoveGroups[$group];
5237 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
5238 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
5239 foreach ( $wgGroupsAddToSelf as $key => $value ) {
5240 if ( is_int( $key ) ) {
5241 $wgGroupsAddToSelf['user'][] = $value;
5246 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
5247 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
5248 if ( is_int( $key ) ) {
5249 $wgGroupsRemoveFromSelf['user'][] = $value;
5254 // Now figure out what groups the user can add to him/herself
5255 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
5257 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
5258 // No idea WHY this would be used, but it's there
5259 $groups['add-self'] = self
::getAllGroups();
5260 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
5261 $groups['add-self'] = $wgGroupsAddToSelf[$group];
5264 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
5266 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
5267 $groups['remove-self'] = self
::getAllGroups();
5268 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
5269 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
5276 * Returns an array of groups that this user can add and remove
5277 * @return array Array( 'add' => array( addablegroups ),
5278 * 'remove' => array( removablegroups ),
5279 * 'add-self' => array( addablegroups to self),
5280 * 'remove-self' => array( removable groups from self) )
5282 public function changeableGroups() {
5283 if ( $this->isAllowed( 'userrights' ) ) {
5284 // This group gives the right to modify everything (reverse-
5285 // compatibility with old "userrights lets you change
5287 // Using array_merge to make the groups reindexed
5288 $all = array_merge( self
::getAllGroups() );
5297 // Okay, it's not so simple, we will have to go through the arrays
5304 $addergroups = $this->getEffectiveGroups();
5306 foreach ( $addergroups as $addergroup ) {
5307 $groups = array_merge_recursive(
5308 $groups, $this->changeableByGroup( $addergroup )
5310 $groups['add'] = array_unique( $groups['add'] );
5311 $groups['remove'] = array_unique( $groups['remove'] );
5312 $groups['add-self'] = array_unique( $groups['add-self'] );
5313 $groups['remove-self'] = array_unique( $groups['remove-self'] );
5319 * Deferred version of incEditCountImmediate()
5321 * This function, rather than incEditCountImmediate(), should be used for
5322 * most cases as it avoids potential deadlocks caused by concurrent editing.
5324 public function incEditCount() {
5325 wfGetDB( DB_MASTER
)->onTransactionPreCommitOrIdle(
5327 $this->incEditCountImmediate();
5334 * Increment the user's edit-count field.
5335 * Will have no effect for anonymous users.
5338 public function incEditCountImmediate() {
5339 if ( $this->isAnon() ) {
5343 $dbw = wfGetDB( DB_MASTER
);
5344 // No rows will be "affected" if user_editcount is NULL
5347 [ 'user_editcount=user_editcount+1' ],
5348 [ 'user_id' => $this->getId(), 'user_editcount IS NOT NULL' ],
5351 // Lazy initialization check...
5352 if ( $dbw->affectedRows() == 0 ) {
5353 // Now here's a goddamn hack...
5354 $dbr = wfGetDB( DB_REPLICA
);
5355 if ( $dbr !== $dbw ) {
5356 // If we actually have a replica DB server, the count is
5357 // at least one behind because the current transaction
5358 // has not been committed and replicated.
5359 $this->mEditCount
= $this->initEditCount( 1 );
5361 // But if DB_REPLICA is selecting the master, then the
5362 // count we just read includes the revision that was
5363 // just added in the working transaction.
5364 $this->mEditCount
= $this->initEditCount();
5367 if ( $this->mEditCount
=== null ) {
5368 $this->getEditCount();
5369 $dbr = wfGetDB( DB_REPLICA
);
5370 $this->mEditCount +
= ( $dbr !== $dbw ) ?
1 : 0;
5372 $this->mEditCount++
;
5375 // Edit count in user cache too
5376 $this->invalidateCache();
5380 * Initialize user_editcount from data out of the revision table
5382 * @param int $add Edits to add to the count from the revision table
5383 * @return int Number of edits
5385 protected function initEditCount( $add = 0 ) {
5386 // Pull from a replica DB to be less cruel to servers
5387 // Accuracy isn't the point anyway here
5388 $dbr = wfGetDB( DB_REPLICA
);
5389 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5390 $count = (int)$dbr->selectField(
5391 [ 'revision' ] +
$actorWhere['tables'],
5393 [ $actorWhere['conds'] ],
5396 $actorWhere['joins']
5398 $count = $count +
$add;
5400 $dbw = wfGetDB( DB_MASTER
);
5403 [ 'user_editcount' => $count ],
5404 [ 'user_id' => $this->getId() ],
5412 * Get the description of a given right
5415 * @param string $right Right to query
5416 * @return string Localized description of the right
5418 public static function getRightDescription( $right ) {
5419 $key = "right-$right";
5420 $msg = wfMessage( $key );
5421 return $msg->isDisabled() ?
$right : $msg->text();
5425 * Get the name of a given grant
5428 * @param string $grant Grant to query
5429 * @return string Localized name of the grant
5431 public static function getGrantName( $grant ) {
5432 $key = "grant-$grant";
5433 $msg = wfMessage( $key );
5434 return $msg->isDisabled() ?
$grant : $msg->text();
5438 * Add a newuser log entry for this user.
5439 * Before 1.19 the return value was always true.
5441 * @deprecated since 1.27, AuthManager handles logging
5442 * @param string|bool $action Account creation type.
5443 * - String, one of the following values:
5444 * - 'create' for an anonymous user creating an account for himself.
5445 * This will force the action's performer to be the created user itself,
5446 * no matter the value of $wgUser
5447 * - 'create2' for a logged in user creating an account for someone else
5448 * - 'byemail' when the created user will receive its password by e-mail
5449 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5450 * - Boolean means whether the account was created by e-mail (deprecated):
5451 * - true will be converted to 'byemail'
5452 * - false will be converted to 'create' if this object is the same as
5453 * $wgUser and to 'create2' otherwise
5454 * @param string $reason User supplied reason
5457 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5458 return true; // disabled
5462 * Add an autocreate newuser log entry for this user
5463 * Used by things like CentralAuth and perhaps other authplugins.
5464 * Consider calling addNewUserLogEntry() directly instead.
5466 * @deprecated since 1.27, AuthManager handles logging
5469 public function addNewUserLogEntryAutoCreate() {
5470 $this->addNewUserLogEntry( 'autocreate' );
5476 * Load the user options either from cache, the database or an array
5478 * @param array|null $data Rows for the current user out of the user_properties table
5480 protected function loadOptions( $data = null ) {
5483 if ( $this->mOptionsLoaded
) {
5487 $this->mOptions
= self
::getDefaultOptions();
5489 if ( !$this->getId() ) {
5490 // For unlogged-in users, load language/variant options from request.
5491 // There's no need to do it for logged-in users: they can set preferences,
5492 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5493 // so don't override user's choice (especially when the user chooses site default).
5494 $variant = MediaWikiServices
::getInstance()->getContentLanguage()->getDefaultVariant();
5495 $this->mOptions
['variant'] = $variant;
5496 $this->mOptions
['language'] = $variant;
5497 $this->mOptionsLoaded
= true;
5501 // Maybe load from the object
5502 if ( !is_null( $this->mOptionOverrides
) ) {
5503 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5504 foreach ( $this->mOptionOverrides
as $key => $value ) {
5505 $this->mOptions
[$key] = $value;
5508 if ( !is_array( $data ) ) {
5509 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5510 // Load from database
5511 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5512 ?
wfGetDB( DB_MASTER
)
5513 : wfGetDB( DB_REPLICA
);
5515 $res = $dbr->select(
5517 [ 'up_property', 'up_value' ],
5518 [ 'up_user' => $this->getId() ],
5522 $this->mOptionOverrides
= [];
5524 foreach ( $res as $row ) {
5525 // Convert '0' to 0. PHP's boolean conversion considers them both
5526 // false, but e.g. JavaScript considers the former as true.
5527 // @todo: T54542 Somehow determine the desired type (string/int/bool)
5528 // and convert all values here.
5529 if ( $row->up_value
=== '0' ) {
5532 $data[$row->up_property
] = $row->up_value
;
5536 foreach ( $data as $property => $value ) {
5537 $this->mOptionOverrides
[$property] = $value;
5538 $this->mOptions
[$property] = $value;
5542 // Replace deprecated language codes
5543 $this->mOptions
['language'] = LanguageCode
::replaceDeprecatedCodes(
5544 $this->mOptions
['language']
5547 $this->mOptionsLoaded
= true;
5549 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5553 * Saves the non-default options for this user, as previously set e.g. via
5554 * setOption(), in the database's "user_properties" (preferences) table.
5555 * Usually used via saveSettings().
5557 protected function saveOptions() {
5558 $this->loadOptions();
5560 // Not using getOptions(), to keep hidden preferences in database
5561 $saveOptions = $this->mOptions
;
5563 // Allow hooks to abort, for instance to save to a global profile.
5564 // Reset options to default state before saving.
5565 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5569 $userId = $this->getId();
5571 $insert_rows = []; // all the new preference rows
5572 foreach ( $saveOptions as $key => $value ) {
5573 // Don't bother storing default values
5574 $defaultOption = self
::getDefaultOption( $key );
5575 if ( ( $defaultOption === null && $value !== false && $value !== null )
5576 ||
$value != $defaultOption
5579 'up_user' => $userId,
5580 'up_property' => $key,
5581 'up_value' => $value,
5586 $dbw = wfGetDB( DB_MASTER
);
5588 $res = $dbw->select( 'user_properties',
5589 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5591 // Find prior rows that need to be removed or updated. These rows will
5592 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5594 foreach ( $res as $row ) {
5595 if ( !isset( $saveOptions[$row->up_property
] )
5596 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5598 $keysDelete[] = $row->up_property
;
5602 if ( count( $keysDelete ) ) {
5603 // Do the DELETE by PRIMARY KEY for prior rows.
5604 // In the past a very large portion of calls to this function are for setting
5605 // 'rememberpassword' for new accounts (a preference that has since been removed).
5606 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5607 // caused gap locks on [max user ID,+infinity) which caused high contention since
5608 // updates would pile up on each other as they are for higher (newer) user IDs.
5609 // It might not be necessary these days, but it shouldn't hurt either.
5610 $dbw->delete( 'user_properties',
5611 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5613 // Insert the new preference rows
5614 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5618 * Return the list of user fields that should be selected to create
5619 * a new user object.
5620 * @deprecated since 1.31, use self::getQueryInfo() instead.
5623 public static function selectFields() {
5624 wfDeprecated( __METHOD__
, '1.31' );
5632 'user_email_authenticated',
5634 'user_email_token_expires',
5635 'user_registration',
5641 * Return the tables, fields, and join conditions to be selected to create
5642 * a new user object.
5644 * @return array With three keys:
5645 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
5646 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
5647 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
5649 public static function getQueryInfo() {
5650 global $wgActorTableSchemaMigrationStage;
5653 'tables' => [ 'user' ],
5661 'user_email_authenticated',
5663 'user_email_token_expires',
5664 'user_registration',
5670 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
5671 // but it does little harm and might be needed for write callers loading a User.
5672 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
5673 $ret['tables']['user_actor'] = 'actor';
5674 $ret['fields'][] = 'user_actor.actor_id';
5675 $ret['joins']['user_actor'] = [
5676 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) ?
'JOIN' : 'LEFT JOIN',
5677 [ 'user_actor.actor_user = user_id' ]
5685 * Factory function for fatal permission-denied errors
5688 * @param string $permission User right required
5691 static function newFatalPermissionDeniedStatus( $permission ) {
5695 foreach ( self
::getGroupsWithPermission( $permission ) as $group ) {
5696 $groups[] = UserGroupMembership
::getLink( $group, RequestContext
::getMain(), 'wiki' );
5700 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5702 return Status
::newFatal( 'badaccess-group0' );
5707 * Get a new instance of this user that was loaded from the master via a locking read
5709 * Use this instead of the main context User when updating that user. This avoids races
5710 * where that user was loaded from a replica DB or even the master but without proper locks.
5712 * @return User|null Returns null if the user was not found in the DB
5715 public function getInstanceForUpdate() {
5716 if ( !$this->getId() ) {
5717 return null; // anon
5720 $user = self
::newFromId( $this->getId() );
5721 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5729 * Checks if two user objects point to the same user.
5731 * @since 1.25 ; takes a UserIdentity instead of a User since 1.32
5732 * @param UserIdentity $user
5735 public function equals( UserIdentity
$user ) {
5736 // XXX it's not clear whether central ID providers are supposed to obey this
5737 return $this->getName() === $user->getName();