3 * Implements the User class for the %MediaWiki software.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\MediaWikiServices
;
24 use MediaWiki\Session\SessionManager
;
25 use MediaWiki\Session\Token
;
26 use MediaWiki\Auth\AuthManager
;
27 use MediaWiki\Auth\AuthenticationResponse
;
28 use MediaWiki\Auth\AuthenticationRequest
;
29 use MediaWiki\User\UserIdentity
;
30 use MediaWiki\Logger\LoggerFactory
;
31 use Wikimedia\Assert\Assert
;
33 use Wikimedia\ScopedCallback
;
34 use Wikimedia\Rdbms\Database
;
35 use Wikimedia\Rdbms\DBExpectedError
;
36 use Wikimedia\Rdbms\IDatabase
;
39 * The User object encapsulates all of the user-specific settings (user_id,
40 * name, rights, email address, options, last login time). Client
41 * classes use the getXXX() functions to access these fields. These functions
42 * do all the work of determining whether the user is logged in,
43 * whether the requested option can be satisfied from cookies or
44 * whether a database query is needed. Most of the settings needed
45 * for rendering normal pages are set in the cookie to minimize use
48 class User
implements IDBAccessObject
, UserIdentity
{
51 * Number of characters required for the user_token field.
53 const TOKEN_LENGTH
= 32;
56 * An invalid string value for the user_token field.
58 const INVALID_TOKEN
= '*** INVALID ***';
61 * Version number to tag cached versions of serialized User objects. Should be increased when
62 * {@link $mCacheVars} or one of it's members changes.
67 * Exclude user options that are set to their default value.
70 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
75 const CHECK_USER_RIGHTS
= true;
80 const IGNORE_USER_RIGHTS
= false;
83 * Array of Strings List of member variables which are saved to the
84 * shared cache (memcached). Any operation which changes the
85 * corresponding database fields must call a cache-clearing function.
88 protected static $mCacheVars = [
96 'mEmailAuthenticated',
103 // user_properties table
110 * Array of Strings Core rights.
111 * Each of these should have a corresponding message of the form
115 protected static $mCoreRights = [
163 'move-categorypages',
164 'move-rootuserpages',
168 'override-export-depth',
190 'userrights-interwiki',
198 * String Cached results of getAllRights()
200 protected static $mAllRights = false;
202 /** Cache variables */
215 /** @var string TS_MW timestamp from the DB */
217 /** @var string TS_MW timestamp from cache */
218 protected $mQuickTouched;
222 public $mEmailAuthenticated;
224 protected $mEmailToken;
226 protected $mEmailTokenExpires;
228 protected $mRegistration;
230 protected $mEditCount;
231 /** @var UserGroupMembership[] Associative array of (group name => UserGroupMembership object) */
232 protected $mGroupMemberships;
234 protected $mOptionOverrides;
238 * Bool Whether the cache variables have been loaded.
241 public $mOptionsLoaded;
244 * Array with already loaded items or true if all items have been loaded.
246 protected $mLoadedItems = [];
250 * String Initialization data source if mLoadedItems!==true. May be one of:
251 * - 'defaults' anonymous user initialised from class defaults
252 * - 'name' initialise from mName
253 * - 'id' initialise from mId
254 * - 'actor' initialise from mActorId
255 * - 'session' log in from session if possible
257 * Use the User::newFrom*() family of functions to set this.
262 * Lazy-initialized variables, invalidated with clearInstanceCache
266 protected $mDatePreference;
274 protected $mBlockreason;
276 protected $mEffectiveGroups;
278 protected $mImplicitGroups;
280 protected $mFormerGroups;
282 protected $mGlobalBlock;
290 /** @var WebRequest */
297 protected $mAllowUsertalk;
300 private $mBlockedFromCreateAccount = false;
302 /** @var int User::READ_* constant bitfield used to load data */
303 protected $queryFlagsUsed = self
::READ_NORMAL
;
305 public static $idCacheByName = [];
308 * Lightweight constructor for an anonymous user.
309 * Use the User::newFrom* factory functions for other kinds of users.
313 * @see newFromActorId()
314 * @see newFromConfirmationCode()
315 * @see newFromSession()
318 public function __construct() {
319 $this->clearInstanceCache( 'defaults' );
325 public function __toString() {
326 return (string)$this->getName();
330 * Test if it's safe to load this User object.
332 * You should typically check this before using $wgUser or
333 * RequestContext::getUser in a method that might be called before the
334 * system has been fully initialized. If the object is unsafe, you should
335 * use an anonymous user:
337 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
343 public function isSafeToLoad() {
344 global $wgFullyInitialised;
346 // The user is safe to load if:
347 // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
348 // * mLoadedItems === true (already loaded)
349 // * mFrom !== 'session' (sessions not involved at all)
351 return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
352 $this->mLoadedItems
=== true ||
$this->mFrom
!== 'session';
356 * Load the user table data for this object from the source given by mFrom.
358 * @param int $flags User::READ_* constant bitfield
360 public function load( $flags = self
::READ_NORMAL
) {
361 global $wgFullyInitialised;
363 if ( $this->mLoadedItems
=== true ) {
367 // Set it now to avoid infinite recursion in accessors
368 $oldLoadedItems = $this->mLoadedItems
;
369 $this->mLoadedItems
= true;
370 $this->queryFlagsUsed
= $flags;
372 // If this is called too early, things are likely to break.
373 if ( !$wgFullyInitialised && $this->mFrom
=== 'session' ) {
374 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
375 ->warning( 'User::loadFromSession called before the end of Setup.php', [
376 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
378 $this->loadDefaults();
379 $this->mLoadedItems
= $oldLoadedItems;
383 switch ( $this->mFrom
) {
385 $this->loadDefaults();
388 // Make sure this thread sees its own changes
389 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
390 if ( $lb->hasOrMadeRecentMasterChanges() ) {
391 $flags |
= self
::READ_LATEST
;
392 $this->queryFlagsUsed
= $flags;
395 $this->mId
= self
::idFromName( $this->mName
, $flags );
397 // Nonexistent user placeholder object
398 $this->loadDefaults( $this->mName
);
400 $this->loadFromId( $flags );
404 // Make sure this thread sees its own changes, if the ID isn't 0
405 if ( $this->mId
!= 0 ) {
406 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
407 if ( $lb->hasOrMadeRecentMasterChanges() ) {
408 $flags |
= self
::READ_LATEST
;
409 $this->queryFlagsUsed
= $flags;
413 $this->loadFromId( $flags );
416 // Make sure this thread sees its own changes
417 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
418 if ( $lb->hasOrMadeRecentMasterChanges() ) {
419 $flags |
= self
::READ_LATEST
;
420 $this->queryFlagsUsed
= $flags;
423 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
424 $row = wfGetDB( $index )->selectRow(
426 [ 'actor_user', 'actor_name' ],
427 [ 'actor_id' => $this->mActorId
],
434 $this->loadDefaults();
435 } elseif ( $row->actor_user
) {
436 $this->mId
= $row->actor_user
;
437 $this->loadFromId( $flags );
439 $this->loadDefaults( $row->actor_name
);
443 if ( !$this->loadFromSession() ) {
444 // Loading from session failed. Load defaults.
445 $this->loadDefaults();
447 Hooks
::run( 'UserLoadAfterLoadFromSession', [ $this ] );
450 throw new UnexpectedValueException(
451 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
456 * Load user table data, given mId has already been set.
457 * @param int $flags User::READ_* constant bitfield
458 * @return bool False if the ID does not exist, true otherwise
460 public function loadFromId( $flags = self
::READ_NORMAL
) {
461 if ( $this->mId
== 0 ) {
462 // Anonymous users are not in the database (don't need cache)
463 $this->loadDefaults();
467 // Try cache (unless this needs data from the master DB).
468 // NOTE: if this thread called saveSettings(), the cache was cleared.
469 $latest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
471 if ( !$this->loadFromDatabase( $flags ) ) {
472 // Can't load from ID
476 $this->loadFromCache();
479 $this->mLoadedItems
= true;
480 $this->queryFlagsUsed
= $flags;
487 * @param string $wikiId
490 public static function purge( $wikiId, $userId ) {
491 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
492 $key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
493 $cache->delete( $key );
498 * @param WANObjectCache $cache
501 protected function getCacheKey( WANObjectCache
$cache ) {
502 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
504 return $cache->makeGlobalKey( 'user', 'id', $lbFactory->getLocalDomainID(), $this->mId
);
508 * @param WANObjectCache $cache
512 public function getMutableCacheKeys( WANObjectCache
$cache ) {
513 $id = $this->getId();
515 return $id ?
[ $this->getCacheKey( $cache ) ] : [];
519 * Load user data from shared cache, given mId has already been set.
524 protected function loadFromCache() {
525 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
526 $data = $cache->getWithSetCallback(
527 $this->getCacheKey( $cache ),
529 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
530 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
531 wfDebug( "User: cache miss for user {$this->mId}\n" );
533 $this->loadFromDatabase( self
::READ_NORMAL
);
535 $this->loadOptions();
538 foreach ( self
::$mCacheVars as $name ) {
539 $data[$name] = $this->$name;
542 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->mTouched
), $ttl );
544 // if a user group membership is about to expire, the cache needs to
545 // expire at that time (T163691)
546 foreach ( $this->mGroupMemberships
as $ugm ) {
547 if ( $ugm->getExpiry() ) {
548 $secondsUntilExpiry = wfTimestamp( TS_UNIX
, $ugm->getExpiry() ) - time();
549 if ( $secondsUntilExpiry > 0 && $secondsUntilExpiry < $ttl ) {
550 $ttl = $secondsUntilExpiry;
557 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'version' => self
::VERSION
]
560 // Restore from cache
561 foreach ( self
::$mCacheVars as $name ) {
562 $this->$name = $data[$name];
568 /** @name newFrom*() static factory methods */
572 * Static factory method for creation from username.
574 * This is slightly less efficient than newFromId(), so use newFromId() if
575 * you have both an ID and a name handy.
577 * @param string $name Username, validated by Title::newFromText()
578 * @param string|bool $validate Validate username. Takes the same parameters as
579 * User::getCanonicalName(), except that true is accepted as an alias
580 * for 'valid', for BC.
582 * @return User|bool User object, or false if the username is invalid
583 * (e.g. if it contains illegal characters or is an IP address). If the
584 * username is not present in the database, the result will be a user object
585 * with a name, zero user ID and default settings.
587 public static function newFromName( $name, $validate = 'valid' ) {
588 if ( $validate === true ) {
591 $name = self
::getCanonicalName( $name, $validate );
592 if ( $name === false ) {
596 // Create unloaded user object
600 $u->setItemLoaded( 'name' );
606 * Static factory method for creation from a given user ID.
608 * @param int $id Valid user ID
609 * @return User The corresponding User object
611 public static function newFromId( $id ) {
615 $u->setItemLoaded( 'id' );
620 * Static factory method for creation from a given actor ID.
623 * @param int $id Valid actor ID
624 * @return User The corresponding User object
626 public static function newFromActorId( $id ) {
627 global $wgActorTableSchemaMigrationStage;
629 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
630 // but it does little harm and might be needed for write callers loading a User.
631 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) ) {
632 throw new BadMethodCallException(
633 'Cannot use ' . __METHOD__
634 . ' when $wgActorTableSchemaMigrationStage lacks SCHEMA_COMPAT_NEW'
641 $u->setItemLoaded( 'actor' );
646 * Returns a User object corresponding to the given UserIdentity.
650 * @param UserIdentity $identity
654 public static function newFromIdentity( UserIdentity
$identity ) {
655 if ( $identity instanceof User
) {
659 return self
::newFromAnyId(
660 $identity->getId() === 0 ?
null : $identity->getId(),
661 $identity->getName() === '' ?
null : $identity->getName(),
662 $identity->getActorId() === 0 ?
null : $identity->getActorId()
667 * Static factory method for creation from an ID, name, and/or actor ID
669 * This does not check that the ID, name, and actor ID all correspond to
673 * @param int|null $userId User ID, if known
674 * @param string|null $userName User name, if known
675 * @param int|null $actorId Actor ID, if known
678 public static function newFromAnyId( $userId, $userName, $actorId ) {
679 global $wgActorTableSchemaMigrationStage;
682 $user->mFrom
= 'defaults';
684 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
685 // but it does little harm and might be needed for write callers loading a User.
686 if ( ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) && $actorId !== null ) {
687 $user->mActorId
= (int)$actorId;
688 if ( $user->mActorId
!== 0 ) {
689 $user->mFrom
= 'actor';
691 $user->setItemLoaded( 'actor' );
694 if ( $userName !== null && $userName !== '' ) {
695 $user->mName
= $userName;
696 $user->mFrom
= 'name';
697 $user->setItemLoaded( 'name' );
700 if ( $userId !== null ) {
701 $user->mId
= (int)$userId;
702 if ( $user->mId
!== 0 ) {
705 $user->setItemLoaded( 'id' );
708 if ( $user->mFrom
=== 'defaults' ) {
709 throw new InvalidArgumentException(
710 'Cannot create a user with no name, no ID, and no actor ID'
718 * Factory method to fetch whichever user has a given email confirmation code.
719 * This code is generated when an account is created or its e-mail address
722 * If the code is invalid or has expired, returns NULL.
724 * @param string $code Confirmation code
725 * @param int $flags User::READ_* bitfield
728 public static function newFromConfirmationCode( $code, $flags = 0 ) {
729 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
730 ?
wfGetDB( DB_MASTER
)
731 : wfGetDB( DB_REPLICA
);
733 $id = $db->selectField(
737 'user_email_token' => md5( $code ),
738 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
742 return $id ? self
::newFromId( $id ) : null;
746 * Create a new user object using data from session. If the login
747 * credentials are invalid, the result is an anonymous user.
749 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
752 public static function newFromSession( WebRequest
$request = null ) {
754 $user->mFrom
= 'session';
755 $user->mRequest
= $request;
760 * Create a new user object from a user row.
761 * The row should have the following fields from the user table in it:
762 * - either user_name or user_id to load further data if needed (or both)
764 * - all other fields (email, etc.)
765 * It is useless to provide the remaining fields if either user_id,
766 * user_name and user_real_name are not provided because the whole row
767 * will be loaded once more from the database when accessing them.
769 * @param stdClass $row A row from the user table
770 * @param array|null $data Further data to load into the object
771 * (see User::loadFromRow for valid keys)
774 public static function newFromRow( $row, $data = null ) {
776 $user->loadFromRow( $row, $data );
781 * Static factory method for creation of a "system" user from username.
783 * A "system" user is an account that's used to attribute logged actions
784 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
785 * might include the 'Maintenance script' or 'Conversion script' accounts
786 * used by various scripts in the maintenance/ directory or accounts such
787 * as 'MediaWiki message delivery' used by the MassMessage extension.
789 * This can optionally create the user if it doesn't exist, and "steal" the
790 * account if it does exist.
792 * "Stealing" an existing user is intended to make it impossible for normal
793 * authentication processes to use the account, effectively disabling the
794 * account for normal use:
795 * - Email is invalidated, to prevent account recovery by emailing a
796 * temporary password and to disassociate the account from the existing
798 * - The token is set to a magic invalid value, to kill existing sessions
799 * and to prevent $this->setToken() calls from resetting the token to a
801 * - SessionManager is instructed to prevent new sessions for the user, to
802 * do things like deauthorizing OAuth consumers.
803 * - AuthManager is instructed to revoke access, to invalidate or remove
804 * passwords and other credentials.
806 * @param string $name Username
807 * @param array $options Options are:
808 * - validate: As for User::getCanonicalName(), default 'valid'
809 * - create: Whether to create the user if it doesn't already exist, default true
810 * - steal: Whether to "disable" the account for normal use if it already
811 * exists, default false
815 public static function newSystemUser( $name, $options = [] ) {
817 'validate' => 'valid',
822 $name = self
::getCanonicalName( $name, $options['validate'] );
823 if ( $name === false ) {
827 $dbr = wfGetDB( DB_REPLICA
);
828 $userQuery = self
::getQueryInfo();
829 $row = $dbr->selectRow(
830 $userQuery['tables'],
831 $userQuery['fields'],
832 [ 'user_name' => $name ],
838 // Try the master database...
839 $dbw = wfGetDB( DB_MASTER
);
840 $row = $dbw->selectRow(
841 $userQuery['tables'],
842 $userQuery['fields'],
843 [ 'user_name' => $name ],
851 // No user. Create it?
852 return $options['create']
853 ? self
::createNew( $name, [ 'token' => self
::INVALID_TOKEN
] )
857 $user = self
::newFromRow( $row );
859 // A user is considered to exist as a non-system user if it can
860 // authenticate, or has an email set, or has a non-invalid token.
861 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
862 AuthManager
::singleton()->userCanAuthenticate( $name )
864 // User exists. Steal it?
865 if ( !$options['steal'] ) {
869 AuthManager
::singleton()->revokeAccessForUser( $name );
871 $user->invalidateEmail();
872 $user->mToken
= self
::INVALID_TOKEN
;
873 $user->saveSettings();
874 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
883 * Get the username corresponding to a given user ID
884 * @param int $id User ID
885 * @return string|bool The corresponding username
887 public static function whoIs( $id ) {
888 return UserCache
::singleton()->getProp( $id, 'name' );
892 * Get the real name of a user given their user ID
894 * @param int $id User ID
895 * @return string|bool The corresponding user's real name
897 public static function whoIsReal( $id ) {
898 return UserCache
::singleton()->getProp( $id, 'real_name' );
902 * Get database id given a user name
903 * @param string $name Username
904 * @param int $flags User::READ_* constant bitfield
905 * @return int|null The corresponding user's ID, or null if user is nonexistent
907 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
908 // Don't explode on self::$idCacheByName[$name] if $name is not a string but e.g. a User object
909 $name = (string)$name;
910 $nt = Title
::makeTitleSafe( NS_USER
, $name );
911 if ( is_null( $nt ) ) {
916 if ( !( $flags & self
::READ_LATEST
) && array_key_exists( $name, self
::$idCacheByName ) ) {
917 return self
::$idCacheByName[$name];
920 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
921 $db = wfGetDB( $index );
926 [ 'user_name' => $nt->getText() ],
931 if ( $s === false ) {
934 $result = (int)$s->user_id
;
937 self
::$idCacheByName[$name] = $result;
939 if ( count( self
::$idCacheByName ) > 1000 ) {
940 self
::$idCacheByName = [];
947 * Reset the cache used in idFromName(). For use in tests.
949 public static function resetIdByNameCache() {
950 self
::$idCacheByName = [];
954 * Does the string match an anonymous IP address?
956 * This function exists for username validation, in order to reject
957 * usernames which are similar in form to IP addresses. Strings such
958 * as 300.300.300.300 will return true because it looks like an IP
959 * address, despite not being strictly valid.
961 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
962 * address because the usemod software would "cloak" anonymous IP
963 * addresses like this, if we allowed accounts like this to be created
964 * new users could get the old edits of these anonymous users.
966 * @param string $name Name to match
969 public static function isIP( $name ) {
970 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
971 || IP
::isIPv6( $name );
975 * Is the user an IP range?
980 public function isIPRange() {
981 return IP
::isValidRange( $this->mName
);
985 * Is the input a valid username?
987 * Checks if the input is a valid username, we don't want an empty string,
988 * an IP address, anything that contains slashes (would mess up subpages),
989 * is longer than the maximum allowed username size or doesn't begin with
992 * @param string $name Name to match
995 public static function isValidUserName( $name ) {
996 global $wgMaxNameChars;
999 || self
::isIP( $name )
1000 ||
strpos( $name, '/' ) !== false
1001 ||
strlen( $name ) > $wgMaxNameChars
1002 ||
$name != MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name )
1007 // Ensure that the name can't be misresolved as a different title,
1008 // such as with extra namespace keys at the start.
1009 $parsed = Title
::newFromText( $name );
1010 if ( is_null( $parsed )
1011 ||
$parsed->getNamespace()
1012 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
1016 // Check an additional blacklist of troublemaker characters.
1017 // Should these be merged into the title char list?
1018 $unicodeBlacklist = '/[' .
1019 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
1020 '\x{00a0}' . # non-breaking space
1021 '\x{2000}-\x{200f}' . # various whitespace
1022 '\x{2028}-\x{202f}' . # breaks and control chars
1023 '\x{3000}' . # ideographic space
1024 '\x{e000}-\x{f8ff}' . # private use
1026 if ( preg_match( $unicodeBlacklist, $name ) ) {
1034 * Usernames which fail to pass this function will be blocked
1035 * from user login and new account registrations, but may be used
1036 * internally by batch processes.
1038 * If an account already exists in this form, login will be blocked
1039 * by a failure to pass this function.
1041 * @param string $name Name to match
1044 public static function isUsableName( $name ) {
1045 global $wgReservedUsernames;
1046 // Must be a valid username, obviously ;)
1047 if ( !self
::isValidUserName( $name ) ) {
1051 static $reservedUsernames = false;
1052 if ( !$reservedUsernames ) {
1053 $reservedUsernames = $wgReservedUsernames;
1054 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
1057 // Certain names may be reserved for batch processes.
1058 foreach ( $reservedUsernames as $reserved ) {
1059 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
1060 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->plain();
1062 if ( $reserved == $name ) {
1070 * Return the users who are members of the given group(s). In case of multiple groups,
1071 * users who are members of at least one of them are returned.
1073 * @param string|array $groups A single group name or an array of group names
1074 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
1075 * records; larger values are ignored.
1076 * @param int|null $after ID the user to start after
1077 * @return UserArrayFromResult
1079 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
1080 if ( $groups === [] ) {
1081 return UserArrayFromResult
::newFromIDs( [] );
1084 $groups = array_unique( (array)$groups );
1085 $limit = min( 5000, $limit );
1087 $conds = [ 'ug_group' => $groups ];
1088 if ( $after !== null ) {
1089 $conds[] = 'ug_user > ' . (int)$after;
1092 $dbr = wfGetDB( DB_REPLICA
);
1093 $ids = $dbr->selectFieldValues(
1100 'ORDER BY' => 'ug_user',
1104 return UserArray
::newFromIDs( $ids );
1108 * Usernames which fail to pass this function will be blocked
1109 * from new account registrations, but may be used internally
1110 * either by batch processes or by user accounts which have
1111 * already been created.
1113 * Additional blacklisting may be added here rather than in
1114 * isValidUserName() to avoid disrupting existing accounts.
1116 * @param string $name String to match
1119 public static function isCreatableName( $name ) {
1120 global $wgInvalidUsernameCharacters;
1122 // Ensure that the username isn't longer than 235 bytes, so that
1123 // (at least for the builtin skins) user javascript and css files
1124 // will work. (T25080)
1125 if ( strlen( $name ) > 235 ) {
1126 wfDebugLog( 'username', __METHOD__
.
1127 ": '$name' invalid due to length" );
1131 // Preg yells if you try to give it an empty string
1132 if ( $wgInvalidUsernameCharacters !== '' &&
1133 preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name )
1135 wfDebugLog( 'username', __METHOD__
.
1136 ": '$name' invalid due to wgInvalidUsernameCharacters" );
1140 return self
::isUsableName( $name );
1144 * Is the input a valid password for this user?
1146 * @param string $password Desired password
1149 public function isValidPassword( $password ) {
1150 // simple boolean wrapper for checkPasswordValidity
1151 return $this->checkPasswordValidity( $password )->isGood();
1155 * Given unvalidated password input, return error message on failure.
1157 * @param string $password Desired password
1158 * @return bool|string|array True on success, string or array of error message on failure
1159 * @deprecated since 1.33, use checkPasswordValidity
1161 public function getPasswordValidity( $password ) {
1162 wfDeprecated( __METHOD__
, '1.33' );
1164 $result = $this->checkPasswordValidity( $password );
1165 if ( $result->isGood() ) {
1170 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
1171 $messages[] = $error['message'];
1173 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
1174 $messages[] = $warning['message'];
1176 if ( count( $messages ) === 1 ) {
1177 return $messages[0];
1184 * Check if this is a valid password for this user
1186 * Returns a Status object with a set of messages describing
1187 * problems with the password. If the return status is fatal,
1188 * the action should be refused and the password should not be
1189 * checked at all (this is mainly meant for DoS mitigation).
1190 * If the return value is OK but not good, the password can be checked,
1191 * but the user should not be able to set their password to this.
1192 * The value of the returned Status object will be an array which
1193 * can have the following fields:
1194 * - forceChange (bool): if set to true, the user should not be
1195 * allowed to log with this password unless they change it during
1196 * the login process (see ResetPasswordSecondaryAuthenticationProvider).
1197 * - suggestChangeOnLogin (bool): if set to true, the user should be prompted for
1198 * a password change on login.
1200 * @param string $password Desired password
1204 public function checkPasswordValidity( $password ) {
1205 global $wgPasswordPolicy;
1207 $upp = new UserPasswordPolicy(
1208 $wgPasswordPolicy['policies'],
1209 $wgPasswordPolicy['checks']
1212 $status = Status
::newGood( [] );
1213 $result = false; // init $result to false for the internal checks
1215 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1216 $status->error( $result );
1220 if ( $result === false ) {
1221 $status->merge( $upp->checkUserPassword( $this, $password ), true );
1225 if ( $result === true ) {
1229 $status->error( $result );
1230 return $status; // the isValidPassword hook set a string $result and returned true
1234 * Given unvalidated user input, return a canonical username, or false if
1235 * the username is invalid.
1236 * @param string $name User input
1237 * @param string|bool $validate Type of validation to use:
1238 * - false No validation
1239 * - 'valid' Valid for batch processes
1240 * - 'usable' Valid for batch processes and login
1241 * - 'creatable' Valid for batch processes, login and account creation
1243 * @throws InvalidArgumentException
1244 * @return bool|string
1246 public static function getCanonicalName( $name, $validate = 'valid' ) {
1247 // Force usernames to capital
1248 $name = MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name );
1250 # Reject names containing '#'; these will be cleaned up
1251 # with title normalisation, but then it's too late to
1253 if ( strpos( $name, '#' ) !== false ) {
1257 // Clean up name according to title rules,
1258 // but only when validation is requested (T14654)
1259 $t = ( $validate !== false ) ?
1260 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1261 // Check for invalid titles
1262 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1266 $name = $t->getText();
1268 switch ( $validate ) {
1272 if ( !self
::isValidUserName( $name ) ) {
1277 if ( !self
::isUsableName( $name ) ) {
1282 if ( !self
::isCreatableName( $name ) ) {
1287 throw new InvalidArgumentException(
1288 'Invalid parameter value for $validate in ' . __METHOD__
);
1294 * Set cached properties to default.
1296 * @note This no longer clears uncached lazy-initialised properties;
1297 * the constructor does that instead.
1299 * @param string|bool $name
1301 public function loadDefaults( $name = false ) {
1303 $this->mName
= $name;
1304 $this->mActorId
= null;
1305 $this->mRealName
= '';
1307 $this->mOptionOverrides
= null;
1308 $this->mOptionsLoaded
= false;
1310 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1311 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1312 if ( $loggedOut !== 0 ) {
1313 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1315 $this->mTouched
= '1'; # Allow any pages to be cached
1318 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1319 $this->mEmailAuthenticated
= null;
1320 $this->mEmailToken
= '';
1321 $this->mEmailTokenExpires
= null;
1322 $this->mRegistration
= wfTimestamp( TS_MW
);
1323 $this->mGroupMemberships
= [];
1325 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1329 * Return whether an item has been loaded.
1331 * @param string $item Item to check. Current possibilities:
1335 * @param string $all 'all' to check if the whole object has been loaded
1336 * or any other string to check if only the item is available (e.g.
1340 public function isItemLoaded( $item, $all = 'all' ) {
1341 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1342 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1346 * Set that an item has been loaded
1348 * @param string $item
1350 protected function setItemLoaded( $item ) {
1351 if ( is_array( $this->mLoadedItems
) ) {
1352 $this->mLoadedItems
[$item] = true;
1357 * Load user data from the session.
1359 * @return bool True if the user is logged in, false otherwise.
1361 private function loadFromSession() {
1364 Hooks
::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1365 if ( $result !== null ) {
1369 // MediaWiki\Session\Session already did the necessary authentication of the user
1370 // returned here, so just use it if applicable.
1371 $session = $this->getRequest()->getSession();
1372 $user = $session->getUser();
1373 if ( $user->isLoggedIn() ) {
1374 $this->loadFromUserObject( $user );
1375 if ( $user->isBlocked() ) {
1376 // If this user is autoblocked, set a cookie to track the Block. This has to be done on
1377 // every session load, because an autoblocked editor might not edit again from the same
1378 // IP address after being blocked.
1379 $this->trackBlockWithCookie();
1382 // Other code expects these to be set in the session, so set them.
1383 $session->set( 'wsUserID', $this->getId() );
1384 $session->set( 'wsUserName', $this->getName() );
1385 $session->set( 'wsToken', $this->getToken() );
1394 * Set the 'BlockID' cookie depending on block type and user authentication status.
1396 public function trackBlockWithCookie() {
1397 $block = $this->getBlock();
1399 if ( $block && $this->getRequest()->getCookie( 'BlockID' ) === null
1400 && $block->shouldTrackWithCookie( $this->isAnon() )
1402 $block->setCookie( $this->getRequest()->response() );
1407 * Load user and user_group data from the database.
1408 * $this->mId must be set, this is how the user is identified.
1410 * @param int $flags User::READ_* constant bitfield
1411 * @return bool True if the user exists, false if the user is anonymous
1413 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1415 $this->mId
= intval( $this->mId
);
1417 if ( !$this->mId
) {
1418 // Anonymous users are not in the database
1419 $this->loadDefaults();
1423 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1424 $db = wfGetDB( $index );
1426 $userQuery = self
::getQueryInfo();
1427 $s = $db->selectRow(
1428 $userQuery['tables'],
1429 $userQuery['fields'],
1430 [ 'user_id' => $this->mId
],
1436 $this->queryFlagsUsed
= $flags;
1437 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1439 if ( $s !== false ) {
1440 // Initialise user table data
1441 $this->loadFromRow( $s );
1442 $this->mGroupMemberships
= null; // deferred
1443 $this->getEditCount(); // revalidation for nulls
1449 $this->loadDefaults();
1455 * Initialize this object from a row from the user table.
1457 * @param stdClass $row Row from the user table to load.
1458 * @param array|null $data Further user data to load into the object
1460 * user_groups Array of arrays or stdClass result rows out of the user_groups
1461 * table. Previously you were supposed to pass an array of strings
1462 * here, but we also need expiry info nowadays, so an array of
1463 * strings is ignored.
1464 * user_properties Array with properties out of the user_properties table
1466 protected function loadFromRow( $row, $data = null ) {
1467 global $wgActorTableSchemaMigrationStage;
1469 if ( !is_object( $row ) ) {
1470 throw new InvalidArgumentException( '$row must be an object' );
1475 $this->mGroupMemberships
= null; // deferred
1477 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
1478 // but it does little harm and might be needed for write callers loading a User.
1479 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
1480 if ( isset( $row->actor_id
) ) {
1481 $this->mActorId
= (int)$row->actor_id
;
1482 if ( $this->mActorId
!== 0 ) {
1483 $this->mFrom
= 'actor';
1485 $this->setItemLoaded( 'actor' );
1491 if ( isset( $row->user_name
) && $row->user_name
!== '' ) {
1492 $this->mName
= $row->user_name
;
1493 $this->mFrom
= 'name';
1494 $this->setItemLoaded( 'name' );
1499 if ( isset( $row->user_real_name
) ) {
1500 $this->mRealName
= $row->user_real_name
;
1501 $this->setItemLoaded( 'realname' );
1506 if ( isset( $row->user_id
) ) {
1507 $this->mId
= intval( $row->user_id
);
1508 if ( $this->mId
!== 0 ) {
1509 $this->mFrom
= 'id';
1511 $this->setItemLoaded( 'id' );
1516 if ( isset( $row->user_id
) && isset( $row->user_name
) && $row->user_name
!== '' ) {
1517 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1520 if ( isset( $row->user_editcount
) ) {
1521 $this->mEditCount
= $row->user_editcount
;
1526 if ( isset( $row->user_touched
) ) {
1527 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1532 if ( isset( $row->user_token
) ) {
1533 // The definition for the column is binary(32), so trim the NULs
1534 // that appends. The previous definition was char(32), so trim
1536 $this->mToken
= rtrim( $row->user_token
, " \0" );
1537 if ( $this->mToken
=== '' ) {
1538 $this->mToken
= null;
1544 if ( isset( $row->user_email
) ) {
1545 $this->mEmail
= $row->user_email
;
1546 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1547 $this->mEmailToken
= $row->user_email_token
;
1548 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1549 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1555 $this->mLoadedItems
= true;
1558 if ( is_array( $data ) ) {
1559 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1560 if ( $data['user_groups'] === [] ) {
1561 $this->mGroupMemberships
= [];
1563 $firstGroup = reset( $data['user_groups'] );
1564 if ( is_array( $firstGroup ) ||
is_object( $firstGroup ) ) {
1565 $this->mGroupMemberships
= [];
1566 foreach ( $data['user_groups'] as $row ) {
1567 $ugm = UserGroupMembership
::newFromRow( (object)$row );
1568 $this->mGroupMemberships
[$ugm->getGroup()] = $ugm;
1573 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1574 $this->loadOptions( $data['user_properties'] );
1580 * Load the data for this user object from another user object.
1584 protected function loadFromUserObject( $user ) {
1586 foreach ( self
::$mCacheVars as $var ) {
1587 $this->$var = $user->$var;
1592 * Load the groups from the database if they aren't already loaded.
1594 private function loadGroups() {
1595 if ( is_null( $this->mGroupMemberships
) ) {
1596 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1597 ?
wfGetDB( DB_MASTER
)
1598 : wfGetDB( DB_REPLICA
);
1599 $this->mGroupMemberships
= UserGroupMembership
::getMembershipsForUser(
1605 * Add the user to the group if he/she meets given criteria.
1607 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1608 * possible to remove manually via Special:UserRights. In such case it
1609 * will not be re-added automatically. The user will also not lose the
1610 * group if they no longer meet the criteria.
1612 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1614 * @return array Array of groups the user has been promoted to.
1616 * @see $wgAutopromoteOnce
1618 public function addAutopromoteOnceGroups( $event ) {
1619 global $wgAutopromoteOnceLogInRC;
1621 if ( wfReadOnly() ||
!$this->getId() ) {
1625 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1626 if ( $toPromote === [] ) {
1630 if ( !$this->checkAndSetTouched() ) {
1631 return []; // raced out (bug T48834)
1634 $oldGroups = $this->getGroups(); // previous groups
1635 $oldUGMs = $this->getGroupMemberships();
1636 foreach ( $toPromote as $group ) {
1637 $this->addGroup( $group );
1639 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1640 $newUGMs = $this->getGroupMemberships();
1642 // update groups in external authentication database
1643 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );
1645 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1646 $logEntry->setPerformer( $this );
1647 $logEntry->setTarget( $this->getUserPage() );
1648 $logEntry->setParameters( [
1649 '4::oldgroups' => $oldGroups,
1650 '5::newgroups' => $newGroups,
1652 $logid = $logEntry->insert();
1653 if ( $wgAutopromoteOnceLogInRC ) {
1654 $logEntry->publish( $logid );
1661 * Builds update conditions. Additional conditions may be added to $conditions to
1662 * protected against race conditions using a compare-and-set (CAS) mechanism
1663 * based on comparing $this->mTouched with the user_touched field.
1665 * @param IDatabase $db
1666 * @param array $conditions WHERE conditions for use with Database::update
1667 * @return array WHERE conditions for use with Database::update
1669 protected function makeUpdateConditions( IDatabase
$db, array $conditions ) {
1670 if ( $this->mTouched
) {
1671 // CAS check: only update if the row wasn't changed sicne it was loaded.
1672 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1679 * Bump user_touched if it didn't change since this object was loaded
1681 * On success, the mTouched field is updated.
1682 * The user serialization cache is always cleared.
1684 * @return bool Whether user_touched was actually updated
1687 protected function checkAndSetTouched() {
1690 if ( !$this->mId
) {
1691 return false; // anon
1694 // Get a new user_touched that is higher than the old one
1695 $newTouched = $this->newTouchedTimestamp();
1697 $dbw = wfGetDB( DB_MASTER
);
1698 $dbw->update( 'user',
1699 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1700 $this->makeUpdateConditions( $dbw, [
1701 'user_id' => $this->mId
,
1705 $success = ( $dbw->affectedRows() > 0 );
1708 $this->mTouched
= $newTouched;
1709 $this->clearSharedCache();
1711 // Clears on failure too since that is desired if the cache is stale
1712 $this->clearSharedCache( 'refresh' );
1719 * Clear various cached data stored in this object. The cache of the user table
1720 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1722 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1723 * given source. May be "name", "id", "actor", "defaults", "session", or false for no reload.
1725 public function clearInstanceCache( $reloadFrom = false ) {
1726 $this->mNewtalk
= -1;
1727 $this->mDatePreference
= null;
1728 $this->mBlockedby
= -1; # Unset
1729 $this->mHash
= false;
1730 $this->mRights
= null;
1731 $this->mEffectiveGroups
= null;
1732 $this->mImplicitGroups
= null;
1733 $this->mGroupMemberships
= null;
1734 $this->mOptions
= null;
1735 $this->mOptionsLoaded
= false;
1736 $this->mEditCount
= null;
1738 if ( $reloadFrom ) {
1739 $this->mLoadedItems
= [];
1740 $this->mFrom
= $reloadFrom;
1744 /** @var array|null */
1745 private static $defOpt = null;
1746 /** @var string|null */
1747 private static $defOptLang = null;
1750 * Reset the process cache of default user options. This is only necessary
1751 * if the wiki configuration has changed since defaults were calculated,
1752 * and as such should only be performed inside the testing suite that
1753 * regularly changes wiki configuration.
1755 public static function resetGetDefaultOptionsForTestsOnly() {
1756 Assert
::invariant( defined( 'MW_PHPUNIT_TEST' ), 'Unit tests only' );
1757 self
::$defOpt = null;
1758 self
::$defOptLang = null;
1762 * Combine the language default options with any site-specific options
1763 * and add the default language variants.
1765 * @return array Array of String options
1767 public static function getDefaultOptions() {
1768 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgDefaultSkin;
1770 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
1771 if ( self
::$defOpt !== null && self
::$defOptLang === $contLang->getCode() ) {
1772 // The content language does not change (and should not change) mid-request, but the
1773 // unit tests change it anyway, and expect this method to return values relevant to the
1774 // current content language.
1775 return self
::$defOpt;
1778 self
::$defOpt = $wgDefaultUserOptions;
1779 // Default language setting
1780 self
::$defOptLang = $contLang->getCode();
1781 self
::$defOpt['language'] = self
::$defOptLang;
1782 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1783 if ( $langCode === $contLang->getCode() ) {
1784 self
::$defOpt['variant'] = $langCode;
1786 self
::$defOpt["variant-$langCode"] = $langCode;
1790 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1791 // since extensions may change the set of searchable namespaces depending
1792 // on user groups/permissions.
1793 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1794 self
::$defOpt['searchNs' . $nsnum] = (bool)$val;
1796 self
::$defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1798 Hooks
::run( 'UserGetDefaultOptions', [ &self
::$defOpt ] );
1800 return self
::$defOpt;
1804 * Get a given default option value.
1806 * @param string $opt Name of option to retrieve
1807 * @return string Default option value
1809 public static function getDefaultOption( $opt ) {
1810 $defOpts = self
::getDefaultOptions();
1811 return $defOpts[$opt] ??
null;
1815 * Get blocking information
1816 * @param bool $fromReplica Whether to check the replica DB first.
1817 * To improve performance, non-critical checks are done against replica DBs.
1818 * Check when actually saving should be done against master.
1820 private function getBlockedStatus( $fromReplica = true ) {
1821 global $wgProxyWhitelist, $wgApplyIpBlocksToXff, $wgSoftBlockRanges;
1823 if ( $this->mBlockedby
!= -1 ) {
1827 wfDebug( __METHOD__
. ": checking...\n" );
1829 // Initialize data...
1830 // Otherwise something ends up stomping on $this->mBlockedby when
1831 // things get lazy-loaded later, causing false positive block hits
1832 // due to -1 !== 0. Probably session-related... Nothing should be
1833 // overwriting mBlockedby, surely?
1836 # We only need to worry about passing the IP address to the Block generator if the
1837 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1838 # know which IP address they're actually coming from
1840 $sessionUser = RequestContext
::getMain()->getUser();
1841 // the session user is set up towards the end of Setup.php. Until then,
1842 // assume it's a logged-out user.
1843 $globalUserName = $sessionUser->isSafeToLoad()
1844 ?
$sessionUser->getName()
1845 : IP
::sanitizeIP( $sessionUser->getRequest()->getIP() );
1846 if ( $this->getName() === $globalUserName && !$this->isAllowed( 'ipblock-exempt' ) ) {
1847 $ip = $this->getRequest()->getIP();
1851 $block = Block
::newFromTarget( $this, $ip, !$fromReplica );
1854 if ( !$block instanceof Block
) {
1855 $block = $this->getBlockFromCookieValue( $this->getRequest()->getCookie( 'BlockID' ) );
1859 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1861 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1862 $block = new Block( [
1863 'byText' => wfMessage( 'proxyblocker' )->text(),
1864 'reason' => wfMessage( 'proxyblockreason' )->plain(),
1866 'systemBlock' => 'proxy',
1868 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1869 $block = new Block( [
1870 'byText' => wfMessage( 'sorbs' )->text(),
1871 'reason' => wfMessage( 'sorbsreason' )->plain(),
1873 'systemBlock' => 'dnsbl',
1878 // (T25343) Apply IP blocks to the contents of XFF headers, if enabled
1879 if ( !$block instanceof Block
1880 && $wgApplyIpBlocksToXff
1882 && !in_array( $ip, $wgProxyWhitelist )
1884 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1885 $xff = array_map( 'trim', explode( ',', $xff ) );
1886 $xff = array_diff( $xff, [ $ip ] );
1887 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$fromReplica );
1888 $block = Block
::chooseBlock( $xffblocks, $xff );
1889 if ( $block instanceof Block
) {
1890 # Mangle the reason to alert the user that the block
1891 # originated from matching the X-Forwarded-For header.
1892 $block->setReason( wfMessage( 'xffblockreason', $block->getReason() )->plain() );
1896 if ( !$block instanceof Block
1899 && IP
::isInRanges( $ip, $wgSoftBlockRanges )
1901 $block = new Block( [
1903 'byText' => 'MediaWiki default',
1904 'reason' => wfMessage( 'softblockrangesreason', $ip )->plain(),
1906 'systemBlock' => 'wgSoftBlockRanges',
1910 if ( $block instanceof Block
) {
1911 wfDebug( __METHOD__
. ": Found block.\n" );
1912 $this->mBlock
= $block;
1913 $this->mBlockedby
= $block->getByName();
1914 $this->mBlockreason
= $block->getReason();
1915 $this->mHideName
= $block->getHideName();
1916 $this->mAllowUsertalk
= $block->isUsertalkEditAllowed();
1918 $this->mBlock
= null;
1919 $this->mBlockedby
= '';
1920 $this->mBlockreason
= '';
1921 $this->mHideName
= 0;
1922 $this->mAllowUsertalk
= false;
1925 // Avoid PHP 7.1 warning of passing $this by reference
1928 Hooks
::run( 'GetBlockedStatus', [ &$thisUser ] );
1932 * Try to load a Block from an ID given in a cookie value.
1933 * @param string|null $blockCookieVal The cookie value to check.
1934 * @return Block|bool The Block object, or false if none could be loaded.
1936 protected function getBlockFromCookieValue( $blockCookieVal ) {
1937 // Make sure there's something to check. The cookie value must start with a number.
1938 if ( strlen( $blockCookieVal ) < 1 ||
!is_numeric( substr( $blockCookieVal, 0, 1 ) ) ) {
1941 // Load the Block from the ID in the cookie.
1942 $blockCookieId = Block
::getIdFromCookieValue( $blockCookieVal );
1943 if ( $blockCookieId !== null ) {
1944 // An ID was found in the cookie.
1945 $tmpBlock = Block
::newFromID( $blockCookieId );
1946 if ( $tmpBlock instanceof Block
) {
1947 $config = RequestContext
::getMain()->getConfig();
1949 switch ( $tmpBlock->getType() ) {
1950 case Block
::TYPE_USER
:
1951 $blockIsValid = !$tmpBlock->isExpired() && $tmpBlock->isAutoblocking();
1952 $useBlockCookie = ( $config->get( 'CookieSetOnAutoblock' ) === true );
1954 case Block
::TYPE_IP
:
1955 case Block
::TYPE_RANGE
:
1956 // If block is type IP or IP range, load only if user is not logged in (T152462)
1957 $blockIsValid = !$tmpBlock->isExpired() && !$this->isLoggedIn();
1958 $useBlockCookie = ( $config->get( 'CookieSetOnIpBlock' ) === true );
1961 $blockIsValid = false;
1962 $useBlockCookie = false;
1965 if ( $blockIsValid && $useBlockCookie ) {
1970 // If the block is not valid, remove the cookie.
1971 Block
::clearCookie( $this->getRequest()->response() );
1973 // If the block doesn't exist, remove the cookie.
1974 Block
::clearCookie( $this->getRequest()->response() );
1981 * Whether the given IP is in a DNS blacklist.
1983 * @param string $ip IP to check
1984 * @param bool $checkWhitelist Whether to check the whitelist first
1985 * @return bool True if blacklisted.
1987 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1988 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1990 if ( !$wgEnableDnsBlacklist ||
1991 ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1996 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
2000 * Whether the given IP is in a given DNS blacklist.
2002 * @param string $ip IP to check
2003 * @param string|array $bases Array of Strings: URL of the DNS blacklist
2004 * @return bool True if blacklisted.
2006 public function inDnsBlacklist( $ip, $bases ) {
2008 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
2009 if ( IP
::isIPv4( $ip ) ) {
2010 // Reverse IP, T23255
2011 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
2013 foreach ( (array)$bases as $base ) {
2015 // If we have an access key, use that too (ProjectHoneypot, etc.)
2017 if ( is_array( $base ) ) {
2018 if ( count( $base ) >= 2 ) {
2019 // Access key is 1, base URL is 0
2020 $host = "{$base[1]}.$ipReversed.{$base[0]}";
2022 $host = "$ipReversed.{$base[0]}";
2024 $basename = $base[0];
2026 $host = "$ipReversed.$base";
2030 $ipList = gethostbynamel( $host );
2033 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
2038 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
2046 * Check if an IP address is in the local proxy list
2052 public static function isLocallyBlockedProxy( $ip ) {
2053 global $wgProxyList;
2055 if ( !$wgProxyList ) {
2059 if ( !is_array( $wgProxyList ) ) {
2060 // Load values from the specified file
2061 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
2064 $resultProxyList = [];
2065 $deprecatedIPEntries = [];
2067 // backward compatibility: move all ip addresses in keys to values
2068 foreach ( $wgProxyList as $key => $value ) {
2069 $keyIsIP = IP
::isIPAddress( $key );
2070 $valueIsIP = IP
::isIPAddress( $value );
2071 if ( $keyIsIP && !$valueIsIP ) {
2072 $deprecatedIPEntries[] = $key;
2073 $resultProxyList[] = $key;
2074 } elseif ( $keyIsIP && $valueIsIP ) {
2075 $deprecatedIPEntries[] = $key;
2076 $resultProxyList[] = $key;
2077 $resultProxyList[] = $value;
2079 $resultProxyList[] = $value;
2083 if ( $deprecatedIPEntries ) {
2085 'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
2086 implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
2089 $proxyListIPSet = new IPSet( $resultProxyList );
2090 return $proxyListIPSet->match( $ip );
2094 * Is this user subject to rate limiting?
2096 * @return bool True if rate limited
2098 public function isPingLimitable() {
2099 global $wgRateLimitsExcludedIPs;
2100 if ( IP
::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
2101 // No other good way currently to disable rate limits
2102 // for specific IPs. :P
2103 // But this is a crappy hack and should die.
2106 return !$this->isAllowed( 'noratelimit' );
2110 * Primitive rate limits: enforce maximum actions per time period
2111 * to put a brake on flooding.
2113 * The method generates both a generic profiling point and a per action one
2114 * (suffix being "-$action".
2116 * @note When using a shared cache like memcached, IP-address
2117 * last-hit counters will be shared across wikis.
2119 * @param string $action Action to enforce; 'edit' if unspecified
2120 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
2121 * @return bool True if a rate limiter was tripped
2123 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
2124 // Avoid PHP 7.1 warning of passing $this by reference
2126 // Call the 'PingLimiter' hook
2128 if ( !Hooks
::run( 'PingLimiter', [ &$user, $action, &$result, $incrBy ] ) ) {
2132 global $wgRateLimits;
2133 if ( !isset( $wgRateLimits[$action] ) ) {
2137 $limits = array_merge(
2138 [ '&can-bypass' => true ],
2139 $wgRateLimits[$action]
2142 // Some groups shouldn't trigger the ping limiter, ever
2143 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
2148 $id = $this->getId();
2150 $isNewbie = $this->isNewbie();
2151 $cache = ObjectCache
::getLocalClusterInstance();
2155 if ( isset( $limits['anon'] ) ) {
2156 $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
2158 } elseif ( isset( $limits['user'] ) ) {
2159 // limits for logged-in users
2160 $userLimit = $limits['user'];
2163 // limits for anons and for newbie logged-in users
2166 if ( isset( $limits['ip'] ) ) {
2167 $ip = $this->getRequest()->getIP();
2168 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
2170 // subnet-based limits
2171 if ( isset( $limits['subnet'] ) ) {
2172 $ip = $this->getRequest()->getIP();
2173 $subnet = IP
::getSubnet( $ip );
2174 if ( $subnet !== false ) {
2175 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
2180 // Check for group-specific permissions
2181 // If more than one group applies, use the group with the highest limit ratio (max/period)
2182 foreach ( $this->getGroups() as $group ) {
2183 if ( isset( $limits[$group] ) ) {
2184 if ( $userLimit === false
2185 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
2187 $userLimit = $limits[$group];
2192 // limits for newbie logged-in users (override all the normal user limits)
2193 if ( $id !== 0 && $isNewbie && isset( $limits['newbie'] ) ) {
2194 $userLimit = $limits['newbie'];
2197 // Set the user limit key
2198 if ( $userLimit !== false ) {
2199 // phan is confused because &can-bypass's value is a bool, so it assumes
2200 // that $userLimit is also a bool here.
2201 // @phan-suppress-next-line PhanTypeInvalidExpressionArrayDestructuring
2202 list( $max, $period ) = $userLimit;
2203 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
2204 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
2207 // ip-based limits for all ping-limitable users
2208 if ( isset( $limits['ip-all'] ) ) {
2209 $ip = $this->getRequest()->getIP();
2210 // ignore if user limit is more permissive
2211 if ( $isNewbie ||
$userLimit === false
2212 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
2213 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
2217 // subnet-based limits for all ping-limitable users
2218 if ( isset( $limits['subnet-all'] ) ) {
2219 $ip = $this->getRequest()->getIP();
2220 $subnet = IP
::getSubnet( $ip );
2221 if ( $subnet !== false ) {
2222 // ignore if user limit is more permissive
2223 if ( $isNewbie ||
$userLimit === false
2224 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
2225 > $userLimit[0] / $userLimit[1] ) {
2226 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
2232 foreach ( $keys as $key => $limit ) {
2233 // phan is confused because &can-bypass's value is a bool, so it assumes
2234 // that $userLimit is also a bool here.
2235 // @phan-suppress-next-line PhanTypeInvalidExpressionArrayDestructuring
2236 list( $max, $period ) = $limit;
2237 $summary = "(limit $max in {$period}s)";
2238 $count = $cache->get( $key );
2241 if ( $count >= $max ) {
2242 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
2243 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
2246 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
2249 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
2250 if ( $incrBy > 0 ) {
2251 $cache->add( $key, 0, intval( $period ) ); // first ping
2254 if ( $incrBy > 0 ) {
2255 $cache->incr( $key, $incrBy );
2263 * Check if user is blocked
2265 * @param bool $fromReplica Whether to check the replica DB instead of
2266 * the master. Hacked from false due to horrible probs on site.
2267 * @return bool True if blocked, false otherwise
2269 public function isBlocked( $fromReplica = true ) {
2270 return $this->getBlock( $fromReplica ) instanceof Block
&&
2271 $this->getBlock()->appliesToRight( 'edit' );
2275 * Get the block affecting the user, or null if the user is not blocked
2277 * @param bool $fromReplica Whether to check the replica DB instead of the master
2278 * @return Block|null
2280 public function getBlock( $fromReplica = true ) {
2281 $this->getBlockedStatus( $fromReplica );
2282 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
2286 * Check if user is blocked from editing a particular article
2288 * @param Title $title Title to check
2289 * @param bool $fromReplica Whether to check the replica DB instead of the master
2291 * @throws MWException
2293 * @deprecated since 1.33,
2294 * use MediaWikiServices::getInstance()->getPermissionManager()->isBlockedFrom(..)
2297 public function isBlockedFrom( $title, $fromReplica = false ) {
2298 return MediaWikiServices
::getInstance()->getPermissionManager()
2299 ->isBlockedFrom( $this, $title, $fromReplica );
2303 * If user is blocked, return the name of the user who placed the block
2304 * @return string Name of blocker
2306 public function blockedBy() {
2307 $this->getBlockedStatus();
2308 return $this->mBlockedby
;
2312 * If user is blocked, return the specified reason for the block
2313 * @return string Blocking reason
2315 public function blockedFor() {
2316 $this->getBlockedStatus();
2317 return $this->mBlockreason
;
2321 * If user is blocked, return the ID for the block
2322 * @return int Block ID
2324 public function getBlockId() {
2325 $this->getBlockedStatus();
2326 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2330 * Check if user is blocked on all wikis.
2331 * Do not use for actual edit permission checks!
2332 * This is intended for quick UI checks.
2334 * @param string $ip IP address, uses current client if none given
2335 * @return bool True if blocked, false otherwise
2337 public function isBlockedGlobally( $ip = '' ) {
2338 return $this->getGlobalBlock( $ip ) instanceof Block
;
2342 * Check if user is blocked on all wikis.
2343 * Do not use for actual edit permission checks!
2344 * This is intended for quick UI checks.
2346 * @param string $ip IP address, uses current client if none given
2347 * @return Block|null Block object if blocked, null otherwise
2348 * @throws FatalError
2349 * @throws MWException
2351 public function getGlobalBlock( $ip = '' ) {
2352 if ( $this->mGlobalBlock
!== null ) {
2353 return $this->mGlobalBlock ?
: null;
2355 // User is already an IP?
2356 if ( IP
::isIPAddress( $this->getName() ) ) {
2357 $ip = $this->getName();
2359 $ip = $this->getRequest()->getIP();
2361 // Avoid PHP 7.1 warning of passing $this by reference
2365 Hooks
::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
2367 if ( $blocked && $block === null ) {
2368 // back-compat: UserIsBlockedGlobally didn't have $block param first
2369 $block = new Block( [
2371 'systemBlock' => 'global-block'
2375 $this->mGlobalBlock
= $blocked ?
$block : false;
2376 return $this->mGlobalBlock ?
: null;
2380 * Check if user account is locked
2382 * @return bool True if locked, false otherwise
2384 public function isLocked() {
2385 if ( $this->mLocked
!== null ) {
2386 return $this->mLocked
;
2389 $this->mLocked
= false;
2390 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2391 return $this->mLocked
;
2395 * Check if user account is hidden
2397 * @return bool True if hidden, false otherwise
2399 public function isHidden() {
2400 if ( $this->mHideName
!== null ) {
2401 return (bool)$this->mHideName
;
2403 $this->getBlockedStatus();
2404 if ( !$this->mHideName
) {
2406 $this->mHideName
= false;
2407 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2409 return (bool)$this->mHideName
;
2413 * Get the user's ID.
2414 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2416 public function getId() {
2417 if ( $this->mId
=== null && $this->mName
!== null && self
::isIP( $this->mName
) ) {
2418 // Special case, we know the user is anonymous
2422 if ( !$this->isItemLoaded( 'id' ) ) {
2423 // Don't load if this was initialized from an ID
2427 return (int)$this->mId
;
2431 * Set the user and reload all fields according to a given ID
2432 * @param int $v User ID to reload
2434 public function setId( $v ) {
2436 $this->clearInstanceCache( 'id' );
2440 * Get the user name, or the IP of an anonymous user
2441 * @return string User's name or IP address
2443 public function getName() {
2444 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2445 // Special case optimisation
2446 return $this->mName
;
2450 if ( $this->mName
=== false ) {
2452 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2455 return $this->mName
;
2459 * Set the user name.
2461 * This does not reload fields from the database according to the given
2462 * name. Rather, it is used to create a temporary "nonexistent user" for
2463 * later addition to the database. It can also be used to set the IP
2464 * address for an anonymous user to something other than the current
2467 * @note User::newFromName() has roughly the same function, when the named user
2469 * @param string $str New user name to set
2471 public function setName( $str ) {
2473 $this->mName
= $str;
2477 * Get the user's actor ID.
2479 * @param IDatabase|null $dbw Assign a new actor ID, using this DB handle, if none exists
2480 * @return int The actor's ID, or 0 if no actor ID exists and $dbw was null
2482 public function getActorId( IDatabase
$dbw = null ) {
2483 global $wgActorTableSchemaMigrationStage;
2485 // Technically we should always return 0 without SCHEMA_COMPAT_READ_NEW,
2486 // but it does little harm and might be needed for write callers loading a User.
2487 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) ) {
2491 if ( !$this->isItemLoaded( 'actor' ) ) {
2495 // Currently $this->mActorId might be null if $this was loaded from a
2496 // cache entry that was written when $wgActorTableSchemaMigrationStage
2497 // was SCHEMA_COMPAT_OLD. Once that is no longer a possibility (i.e. when
2498 // User::VERSION is incremented after $wgActorTableSchemaMigrationStage
2499 // has been removed), that condition may be removed.
2500 if ( $this->mActorId
=== null ||
!$this->mActorId
&& $dbw ) {
2502 'actor_user' => $this->getId() ?
: null,
2503 'actor_name' => (string)$this->getName(),
2506 if ( $q['actor_user'] === null && self
::isUsableName( $q['actor_name'] ) ) {
2507 throw new CannotCreateActorException(
2508 'Cannot create an actor for a usable name that is not an existing user'
2511 if ( $q['actor_name'] === '' ) {
2512 throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
2514 $dbw->insert( 'actor', $q, __METHOD__
, [ 'IGNORE' ] );
2515 if ( $dbw->affectedRows() ) {
2516 $this->mActorId
= (int)$dbw->insertId();
2519 // Use LOCK IN SHARE MODE to bypass any MySQL REPEATABLE-READ snapshot.
2520 $this->mActorId
= (int)$dbw->selectField(
2525 [ 'LOCK IN SHARE MODE' ]
2527 if ( !$this->mActorId
) {
2528 throw new CannotCreateActorException(
2529 "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
2533 $this->invalidateCache();
2535 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2536 $db = wfGetDB( $index );
2537 $this->mActorId
= (int)$db->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2539 $this->setItemLoaded( 'actor' );
2542 return (int)$this->mActorId
;
2546 * Get the user's name escaped by underscores.
2547 * @return string Username escaped by underscores.
2549 public function getTitleKey() {
2550 return str_replace( ' ', '_', $this->getName() );
2554 * Check if the user has new messages.
2555 * @return bool True if the user has new messages
2557 public function getNewtalk() {
2560 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2561 if ( $this->mNewtalk
=== -1 ) {
2562 $this->mNewtalk
= false; # reset talk page status
2564 // Check memcached separately for anons, who have no
2565 // entire User object stored in there.
2566 if ( !$this->mId
) {
2567 global $wgDisableAnonTalk;
2568 if ( $wgDisableAnonTalk ) {
2569 // Anon newtalk disabled by configuration.
2570 $this->mNewtalk
= false;
2572 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2575 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2579 return (bool)$this->mNewtalk
;
2583 * Return the data needed to construct links for new talk page message
2584 * alerts. If there are new messages, this will return an associative array
2585 * with the following data:
2586 * wiki: The database name of the wiki
2587 * link: Root-relative link to the user's talk page
2588 * rev: The last talk page revision that the user has seen or null. This
2589 * is useful for building diff links.
2590 * If there are no new messages, it returns an empty array.
2591 * @note This function was designed to accomodate multiple talk pages, but
2592 * currently only returns a single link and revision.
2595 public function getNewMessageLinks() {
2596 // Avoid PHP 7.1 warning of passing $this by reference
2599 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
2603 if ( !$this->getNewtalk() ) {
2606 $utp = $this->getTalkPage();
2607 $dbr = wfGetDB( DB_REPLICA
);
2608 // Get the "last viewed rev" timestamp from the oldest message notification
2609 $timestamp = $dbr->selectField( 'user_newtalk',
2610 'MIN(user_last_timestamp)',
2611 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2613 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2616 'wiki' => WikiMap
::getWikiIdFromDbDomain( WikiMap
::getCurrentWikiDbDomain() ),
2617 'link' => $utp->getLocalURL(),
2624 * Get the revision ID for the last talk page revision viewed by the talk
2626 * @return int|null Revision ID or null
2628 public function getNewMessageRevisionId() {
2629 $newMessageRevisionId = null;
2630 $newMessageLinks = $this->getNewMessageLinks();
2632 // Note: getNewMessageLinks() never returns more than a single link
2633 // and it is always for the same wiki, but we double-check here in
2634 // case that changes some time in the future.
2635 if ( $newMessageLinks && count( $newMessageLinks ) === 1
2636 && WikiMap
::isCurrentWikiId( $newMessageLinks[0]['wiki'] )
2637 && $newMessageLinks[0]['rev']
2639 /** @var Revision $newMessageRevision */
2640 $newMessageRevision = $newMessageLinks[0]['rev'];
2641 $newMessageRevisionId = $newMessageRevision->getId();
2644 return $newMessageRevisionId;
2648 * Internal uncached check for new messages
2651 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2652 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2653 * @return bool True if the user has new messages
2655 protected function checkNewtalk( $field, $id ) {
2656 $dbr = wfGetDB( DB_REPLICA
);
2658 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2660 return $ok !== false;
2664 * Add or update the new messages flag
2665 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2666 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2667 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2668 * @return bool True if successful, false otherwise
2670 protected function updateNewtalk( $field, $id, $curRev = null ) {
2671 // Get timestamp of the talk page revision prior to the current one
2672 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2673 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2674 // Mark the user as having new messages since this revision
2675 $dbw = wfGetDB( DB_MASTER
);
2676 $dbw->insert( 'user_newtalk',
2677 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2680 if ( $dbw->affectedRows() ) {
2681 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2685 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2690 * Clear the new messages flag for the given user
2691 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2692 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2693 * @return bool True if successful, false otherwise
2695 protected function deleteNewtalk( $field, $id ) {
2696 $dbw = wfGetDB( DB_MASTER
);
2697 $dbw->delete( 'user_newtalk',
2700 if ( $dbw->affectedRows() ) {
2701 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2705 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2710 * Update the 'You have new messages!' status.
2711 * @param bool $val Whether the user has new messages
2712 * @param Revision|null $curRev New, as yet unseen revision of the user talk
2713 * page. Ignored if null or !$val.
2715 public function setNewtalk( $val, $curRev = null ) {
2716 if ( wfReadOnly() ) {
2721 $this->mNewtalk
= $val;
2723 if ( $this->isAnon() ) {
2725 $id = $this->getName();
2728 $id = $this->getId();
2732 $changed = $this->updateNewtalk( $field, $id, $curRev );
2734 $changed = $this->deleteNewtalk( $field, $id );
2738 $this->invalidateCache();
2743 * Generate a current or new-future timestamp to be stored in the
2744 * user_touched field when we update things.
2746 * @return string Timestamp in TS_MW format
2748 private function newTouchedTimestamp() {
2750 if ( $this->mTouched
) {
2751 $time = max( $time, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2754 return wfTimestamp( TS_MW
, $time );
2758 * Clear user data from memcached
2760 * Use after applying updates to the database; caller's
2761 * responsibility to update user_touched if appropriate.
2763 * Called implicitly from invalidateCache() and saveSettings().
2765 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2767 public function clearSharedCache( $mode = 'changed' ) {
2768 if ( !$this->getId() ) {
2772 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2773 $key = $this->getCacheKey( $cache );
2774 if ( $mode === 'refresh' ) {
2775 $cache->delete( $key, 1 );
2777 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2778 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2779 $lb->getConnection( DB_MASTER
)->onTransactionPreCommitOrIdle(
2780 function () use ( $cache, $key ) {
2781 $cache->delete( $key );
2786 $cache->delete( $key );
2792 * Immediately touch the user data cache for this account
2794 * Calls touch() and removes account data from memcached
2796 public function invalidateCache() {
2798 $this->clearSharedCache();
2802 * Update the "touched" timestamp for the user
2804 * This is useful on various login/logout events when making sure that
2805 * a browser or proxy that has multiple tenants does not suffer cache
2806 * pollution where the new user sees the old users content. The value
2807 * of getTouched() is checked when determining 304 vs 200 responses.
2808 * Unlike invalidateCache(), this preserves the User object cache and
2809 * avoids database writes.
2813 public function touch() {
2814 $id = $this->getId();
2816 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2817 $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
2818 $cache->touchCheckKey( $key );
2819 $this->mQuickTouched
= null;
2824 * Validate the cache for this account.
2825 * @param string $timestamp A timestamp in TS_MW format
2828 public function validateCache( $timestamp ) {
2829 return ( $timestamp >= $this->getTouched() );
2833 * Get the user touched timestamp
2835 * Use this value only to validate caches via inequalities
2836 * such as in the case of HTTP If-Modified-Since response logic
2838 * @return string TS_MW Timestamp
2840 public function getTouched() {
2844 if ( $this->mQuickTouched
=== null ) {
2845 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2846 $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId
);
2848 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2851 return max( $this->mTouched
, $this->mQuickTouched
);
2854 return $this->mTouched
;
2858 * Get the user_touched timestamp field (time of last DB updates)
2859 * @return string TS_MW Timestamp
2862 public function getDBTouched() {
2865 return $this->mTouched
;
2869 * Set the password and reset the random token.
2870 * Calls through to authentication plugin if necessary;
2871 * will have no effect if the auth plugin refuses to
2872 * pass the change through or if the legal password
2875 * As a special case, setting the password to null
2876 * wipes it, so the account cannot be logged in until
2877 * a new password is set, for instance via e-mail.
2879 * @deprecated since 1.27, use AuthManager instead
2880 * @param string $str New password to set
2881 * @throws PasswordError On failure
2884 public function setPassword( $str ) {
2885 wfDeprecated( __METHOD__
, '1.27' );
2886 return $this->setPasswordInternal( $str );
2890 * Set the password and reset the random token unconditionally.
2892 * @deprecated since 1.27, use AuthManager instead
2893 * @param string|null $str New password to set or null to set an invalid
2894 * password hash meaning that the user will not be able to log in
2895 * through the web interface.
2897 public function setInternalPassword( $str ) {
2898 wfDeprecated( __METHOD__
, '1.27' );
2899 $this->setPasswordInternal( $str );
2903 * Actually set the password and such
2904 * @since 1.27 cannot set a password for a user not in the database
2905 * @param string|null $str New password to set or null to set an invalid
2906 * password hash meaning that the user will not be able to log in
2907 * through the web interface.
2908 * @return bool Success
2910 private function setPasswordInternal( $str ) {
2911 $manager = AuthManager
::singleton();
2913 // If the user doesn't exist yet, fail
2914 if ( !$manager->userExists( $this->getName() ) ) {
2915 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2918 $status = $this->changeAuthenticationData( [
2919 'username' => $this->getName(),
2923 if ( !$status->isGood() ) {
2924 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2925 ->info( __METHOD__
. ': Password change rejected: '
2926 . $status->getWikiText( null, null, 'en' ) );
2930 $this->setOption( 'watchlisttoken', false );
2931 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2937 * Changes credentials of the user.
2939 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2940 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2941 * e.g. when no provider handled the change.
2943 * @param array $data A set of authentication data in fieldname => value format. This is the
2944 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2948 public function changeAuthenticationData( array $data ) {
2949 $manager = AuthManager
::singleton();
2950 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2951 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2953 $status = Status
::newGood( 'ignored' );
2954 foreach ( $reqs as $req ) {
2955 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2957 if ( $status->getValue() === 'ignored' ) {
2958 $status->warning( 'authenticationdatachange-ignored' );
2961 if ( $status->isGood() ) {
2962 foreach ( $reqs as $req ) {
2963 $manager->changeAuthenticationData( $req );
2970 * Get the user's current token.
2971 * @param bool $forceCreation Force the generation of a new token if the
2972 * user doesn't have one (default=true for backwards compatibility).
2973 * @return string|null Token
2975 public function getToken( $forceCreation = true ) {
2976 global $wgAuthenticationTokenVersion;
2979 if ( !$this->mToken
&& $forceCreation ) {
2983 if ( !$this->mToken
) {
2984 // The user doesn't have a token, return null to indicate that.
2988 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
2989 // We return a random value here so existing token checks are very
2991 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2994 if ( $wgAuthenticationTokenVersion === null ) {
2995 // $wgAuthenticationTokenVersion not in use, so return the raw secret
2996 return $this->mToken
;
2999 // $wgAuthenticationTokenVersion in use, so hmac it.
3000 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
3002 // The raw hash can be overly long. Shorten it up.
3003 $len = max( 32, self
::TOKEN_LENGTH
);
3004 if ( strlen( $ret ) < $len ) {
3005 // Should never happen, even md5 is 128 bits
3006 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
3009 return substr( $ret, -$len );
3013 * Set the random token (used for persistent authentication)
3014 * Called from loadDefaults() among other places.
3016 * @param string|bool $token If specified, set the token to this value
3018 public function setToken( $token = false ) {
3020 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
3021 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3022 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
3023 } elseif ( !$token ) {
3024 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3026 $this->mToken
= $token;
3031 * Set the password for a password reminder or new account email
3033 * @deprecated Removed in 1.27. Use PasswordReset instead.
3034 * @param string $str New password to set or null to set an invalid
3035 * password hash meaning that the user will not be able to use it
3036 * @param bool $throttle If true, reset the throttle timestamp to the present
3038 public function setNewpassword( $str, $throttle = true ) {
3039 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
3043 * Get the user's e-mail address
3044 * @return string User's email address
3046 public function getEmail() {
3048 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
3049 return $this->mEmail
;
3053 * Get the timestamp of the user's e-mail authentication
3054 * @return string TS_MW timestamp
3056 public function getEmailAuthenticationTimestamp() {
3058 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
3059 return $this->mEmailAuthenticated
;
3063 * Set the user's e-mail address
3064 * @param string $str New e-mail address
3066 public function setEmail( $str ) {
3068 if ( $str == $this->mEmail
) {
3071 $this->invalidateEmail();
3072 $this->mEmail
= $str;
3073 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
3077 * Set the user's e-mail address and a confirmation mail if needed.
3080 * @param string $str New e-mail address
3083 public function setEmailWithConfirmation( $str ) {
3084 global $wgEnableEmail, $wgEmailAuthentication;
3086 if ( !$wgEnableEmail ) {
3087 return Status
::newFatal( 'emaildisabled' );
3090 $oldaddr = $this->getEmail();
3091 if ( $str === $oldaddr ) {
3092 return Status
::newGood( true );
3095 $type = $oldaddr != '' ?
'changed' : 'set';
3096 $notificationResult = null;
3098 if ( $wgEmailAuthentication && $type === 'changed' ) {
3099 // Send the user an email notifying the user of the change in registered
3100 // email address on their previous email address
3101 $change = $str != '' ?
'changed' : 'removed';
3102 $notificationResult = $this->sendMail(
3103 wfMessage( 'notificationemail_subject_' . $change )->text(),
3104 wfMessage( 'notificationemail_body_' . $change,
3105 $this->getRequest()->getIP(),
3111 $this->setEmail( $str );
3113 if ( $str !== '' && $wgEmailAuthentication ) {
3114 // Send a confirmation request to the new address if needed
3115 $result = $this->sendConfirmationMail( $type );
3117 if ( $notificationResult !== null ) {
3118 $result->merge( $notificationResult );
3121 if ( $result->isGood() ) {
3122 // Say to the caller that a confirmation and notification mail has been sent
3123 $result->value
= 'eauth';
3126 $result = Status
::newGood( true );
3133 * Get the user's real name
3134 * @return string User's real name
3136 public function getRealName() {
3137 if ( !$this->isItemLoaded( 'realname' ) ) {
3141 return $this->mRealName
;
3145 * Set the user's real name
3146 * @param string $str New real name
3148 public function setRealName( $str ) {
3150 $this->mRealName
= $str;
3154 * Get the user's current setting for a given option.
3156 * @param string $oname The option to check
3157 * @param string|array|null $defaultOverride A default value returned if the option does not exist
3158 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
3159 * @return string|array|int|null User's current value for the option
3160 * @see getBoolOption()
3161 * @see getIntOption()
3163 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
3164 global $wgHiddenPrefs;
3165 $this->loadOptions();
3167 # We want 'disabled' preferences to always behave as the default value for
3168 # users, even if they have set the option explicitly in their settings (ie they
3169 # set it, and then it was disabled removing their ability to change it). But
3170 # we don't want to erase the preferences in the database in case the preference
3171 # is re-enabled again. So don't touch $mOptions, just override the returned value
3172 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
3173 return self
::getDefaultOption( $oname );
3176 if ( array_key_exists( $oname, $this->mOptions
) ) {
3177 return $this->mOptions
[$oname];
3180 return $defaultOverride;
3184 * Get all user's options
3186 * @param int $flags Bitwise combination of:
3187 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
3188 * to the default value. (Since 1.25)
3191 public function getOptions( $flags = 0 ) {
3192 global $wgHiddenPrefs;
3193 $this->loadOptions();
3194 $options = $this->mOptions
;
3196 # We want 'disabled' preferences to always behave as the default value for
3197 # users, even if they have set the option explicitly in their settings (ie they
3198 # set it, and then it was disabled removing their ability to change it). But
3199 # we don't want to erase the preferences in the database in case the preference
3200 # is re-enabled again. So don't touch $mOptions, just override the returned value
3201 foreach ( $wgHiddenPrefs as $pref ) {
3202 $default = self
::getDefaultOption( $pref );
3203 if ( $default !== null ) {
3204 $options[$pref] = $default;
3208 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
3209 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
3216 * Get the user's current setting for a given option, as a boolean value.
3218 * @param string $oname The option to check
3219 * @return bool User's current value for the option
3222 public function getBoolOption( $oname ) {
3223 return (bool)$this->getOption( $oname );
3227 * Get the user's current setting for a given option, as an integer value.
3229 * @param string $oname The option to check
3230 * @param int $defaultOverride A default value returned if the option does not exist
3231 * @return int User's current value for the option
3234 public function getIntOption( $oname, $defaultOverride = 0 ) {
3235 $val = $this->getOption( $oname );
3237 $val = $defaultOverride;
3239 return intval( $val );
3243 * Set the given option for a user.
3245 * You need to call saveSettings() to actually write to the database.
3247 * @param string $oname The option to set
3248 * @param mixed $val New value to set
3250 public function setOption( $oname, $val ) {
3251 $this->loadOptions();
3253 // Explicitly NULL values should refer to defaults
3254 if ( is_null( $val ) ) {
3255 $val = self
::getDefaultOption( $oname );
3258 $this->mOptions
[$oname] = $val;
3262 * Get a token stored in the preferences (like the watchlist one),
3263 * resetting it if it's empty (and saving changes).
3265 * @param string $oname The option name to retrieve the token from
3266 * @return string|bool User's current value for the option, or false if this option is disabled.
3267 * @see resetTokenFromOption()
3269 * @deprecated since 1.26 Applications should use the OAuth extension
3271 public function getTokenFromOption( $oname ) {
3272 global $wgHiddenPrefs;
3274 $id = $this->getId();
3275 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
3279 $token = $this->getOption( $oname );
3281 // Default to a value based on the user token to avoid space
3282 // wasted on storing tokens for all users. When this option
3283 // is set manually by the user, only then is it stored.
3284 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
3291 * Reset a token stored in the preferences (like the watchlist one).
3292 * *Does not* save user's preferences (similarly to setOption()).
3294 * @param string $oname The option name to reset the token in
3295 * @return string|bool New token value, or false if this option is disabled.
3296 * @see getTokenFromOption()
3299 public function resetTokenFromOption( $oname ) {
3300 global $wgHiddenPrefs;
3301 if ( in_array( $oname, $wgHiddenPrefs ) ) {
3305 $token = MWCryptRand
::generateHex( 40 );
3306 $this->setOption( $oname, $token );
3311 * Return a list of the types of user options currently returned by
3312 * User::getOptionKinds().
3314 * Currently, the option kinds are:
3315 * - 'registered' - preferences which are registered in core MediaWiki or
3316 * by extensions using the UserGetDefaultOptions hook.
3317 * - 'registered-multiselect' - as above, using the 'multiselect' type.
3318 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
3319 * - 'userjs' - preferences with names starting with 'userjs-', intended to
3320 * be used by user scripts.
3321 * - 'special' - "preferences" that are not accessible via User::getOptions
3322 * or User::setOptions.
3323 * - 'unused' - preferences about which MediaWiki doesn't know anything.
3324 * These are usually legacy options, removed in newer versions.
3326 * The API (and possibly others) use this function to determine the possible
3327 * option types for validation purposes, so make sure to update this when a
3328 * new option kind is added.
3330 * @see User::getOptionKinds
3331 * @return array Option kinds
3333 public static function listOptionKinds() {
3336 'registered-multiselect',
3337 'registered-checkmatrix',
3345 * Return an associative array mapping preferences keys to the kind of a preference they're
3346 * used for. Different kinds are handled differently when setting or reading preferences.
3348 * See User::listOptionKinds for the list of valid option types that can be provided.
3350 * @see User::listOptionKinds
3351 * @param IContextSource $context
3352 * @param array|null $options Assoc. array with options keys to check as keys.
3353 * Defaults to $this->mOptions.
3354 * @return array The key => kind mapping data
3356 public function getOptionKinds( IContextSource
$context, $options = null ) {
3357 $this->loadOptions();
3358 if ( $options === null ) {
3359 $options = $this->mOptions
;
3362 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
3363 $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
3366 // Pull out the "special" options, so they don't get converted as
3367 // multiselect or checkmatrix.
3368 $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
3369 foreach ( $specialOptions as $name => $value ) {
3370 unset( $prefs[$name] );
3373 // Multiselect and checkmatrix options are stored in the database with
3374 // one key per option, each having a boolean value. Extract those keys.
3375 $multiselectOptions = [];
3376 foreach ( $prefs as $name => $info ) {
3377 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3378 ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField
::class ) ) {
3379 $opts = HTMLFormField
::flattenOptions( $info['options'] );
3380 $prefix = $info['prefix'] ??
$name;
3382 foreach ( $opts as $value ) {
3383 $multiselectOptions["$prefix$value"] = true;
3386 unset( $prefs[$name] );
3389 $checkmatrixOptions = [];
3390 foreach ( $prefs as $name => $info ) {
3391 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3392 ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix
::class ) ) {
3393 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3394 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3395 $prefix = $info['prefix'] ??
$name;
3397 foreach ( $columns as $column ) {
3398 foreach ( $rows as $row ) {
3399 $checkmatrixOptions["$prefix$column-$row"] = true;
3403 unset( $prefs[$name] );
3407 // $value is ignored
3408 foreach ( $options as $key => $value ) {
3409 if ( isset( $prefs[$key] ) ) {
3410 $mapping[$key] = 'registered';
3411 } elseif ( isset( $multiselectOptions[$key] ) ) {
3412 $mapping[$key] = 'registered-multiselect';
3413 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3414 $mapping[$key] = 'registered-checkmatrix';
3415 } elseif ( isset( $specialOptions[$key] ) ) {
3416 $mapping[$key] = 'special';
3417 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3418 $mapping[$key] = 'userjs';
3420 $mapping[$key] = 'unused';
3428 * Reset certain (or all) options to the site defaults
3430 * The optional parameter determines which kinds of preferences will be reset.
3431 * Supported values are everything that can be reported by getOptionKinds()
3432 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3434 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3435 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3436 * for backwards-compatibility.
3437 * @param IContextSource|null $context Context source used when $resetKinds
3438 * does not contain 'all', passed to getOptionKinds().
3439 * Defaults to RequestContext::getMain() when null.
3441 public function resetOptions(
3442 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3443 IContextSource
$context = null
3446 $defaultOptions = self
::getDefaultOptions();
3448 if ( !is_array( $resetKinds ) ) {
3449 $resetKinds = [ $resetKinds ];
3452 if ( in_array( 'all', $resetKinds ) ) {
3453 $newOptions = $defaultOptions;
3455 if ( $context === null ) {
3456 $context = RequestContext
::getMain();
3459 $optionKinds = $this->getOptionKinds( $context );
3460 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3463 // Use default values for the options that should be deleted, and
3464 // copy old values for the ones that shouldn't.
3465 foreach ( $this->mOptions
as $key => $value ) {
3466 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3467 if ( array_key_exists( $key, $defaultOptions ) ) {
3468 $newOptions[$key] = $defaultOptions[$key];
3471 $newOptions[$key] = $value;
3476 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3478 $this->mOptions
= $newOptions;
3479 $this->mOptionsLoaded
= true;
3483 * Get the user's preferred date format.
3484 * @return string User's preferred date format
3486 public function getDatePreference() {
3487 // Important migration for old data rows
3488 if ( is_null( $this->mDatePreference
) ) {
3490 $value = $this->getOption( 'date' );
3491 $map = $wgLang->getDatePreferenceMigrationMap();
3492 if ( isset( $map[$value] ) ) {
3493 $value = $map[$value];
3495 $this->mDatePreference
= $value;
3497 return $this->mDatePreference
;
3501 * Determine based on the wiki configuration and the user's options,
3502 * whether this user must be over HTTPS no matter what.
3506 public function requiresHTTPS() {
3507 global $wgSecureLogin;
3508 if ( !$wgSecureLogin ) {
3512 $https = $this->getBoolOption( 'prefershttps' );
3513 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3515 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3522 * Get the user preferred stub threshold
3526 public function getStubThreshold() {
3527 global $wgMaxArticleSize; # Maximum article size, in Kb
3528 $threshold = $this->getIntOption( 'stubthreshold' );
3529 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3530 // If they have set an impossible value, disable the preference
3531 // so we can use the parser cache again.
3538 * Get the permissions this user has.
3539 * @return string[] permission names
3541 public function getRights() {
3542 if ( is_null( $this->mRights
) ) {
3543 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3544 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3546 // Deny any rights denied by the user's session, unless this
3547 // endpoint has no sessions.
3548 if ( !defined( 'MW_NO_SESSION' ) ) {
3549 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3550 if ( $allowedRights !== null ) {
3551 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3555 Hooks
::run( 'UserGetRightsRemove', [ $this, &$this->mRights
] );
3556 // Force reindexation of rights when a hook has unset one of them
3557 $this->mRights
= array_values( array_unique( $this->mRights
) );
3559 // If block disables login, we should also remove any
3560 // extra rights blocked users might have, in case the
3561 // blocked user has a pre-existing session (T129738).
3562 // This is checked here for cases where people only call
3563 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3564 // to give a better error message in the common case.
3565 $config = RequestContext
::getMain()->getConfig();
3567 $this->isLoggedIn() &&
3568 $config->get( 'BlockDisablesLogin' ) &&
3572 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3575 return $this->mRights
;
3579 * Get the list of explicit group memberships this user has.
3580 * The implicit * and user groups are not included.
3582 * @return string[] Array of internal group names (sorted since 1.33)
3584 public function getGroups() {
3586 $this->loadGroups();
3587 return array_keys( $this->mGroupMemberships
);
3591 * Get the list of explicit group memberships this user has, stored as
3592 * UserGroupMembership objects. Implicit groups are not included.
3594 * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
3597 public function getGroupMemberships() {
3599 $this->loadGroups();
3600 return $this->mGroupMemberships
;
3604 * Get the list of implicit group memberships this user has.
3605 * This includes all explicit groups, plus 'user' if logged in,
3606 * '*' for all accounts, and autopromoted groups
3607 * @param bool $recache Whether to avoid the cache
3608 * @return array Array of String internal group names
3610 public function getEffectiveGroups( $recache = false ) {
3611 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3612 $this->mEffectiveGroups
= array_unique( array_merge(
3613 $this->getGroups(), // explicit groups
3614 $this->getAutomaticGroups( $recache ) // implicit groups
3616 // Avoid PHP 7.1 warning of passing $this by reference
3618 // Hook for additional groups
3619 Hooks
::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups
] );
3620 // Force reindexation of groups when a hook has unset one of them
3621 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3623 return $this->mEffectiveGroups
;
3627 * Get the list of implicit group memberships this user has.
3628 * This includes 'user' if logged in, '*' for all accounts,
3629 * and autopromoted groups
3630 * @param bool $recache Whether to avoid the cache
3631 * @return array Array of String internal group names
3633 public function getAutomaticGroups( $recache = false ) {
3634 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3635 $this->mImplicitGroups
= [ '*' ];
3636 if ( $this->getId() ) {
3637 $this->mImplicitGroups
[] = 'user';
3639 $this->mImplicitGroups
= array_unique( array_merge(
3640 $this->mImplicitGroups
,
3641 Autopromote
::getAutopromoteGroups( $this )
3645 // Assure data consistency with rights/groups,
3646 // as getEffectiveGroups() depends on this function
3647 $this->mEffectiveGroups
= null;
3650 return $this->mImplicitGroups
;
3654 * Returns the groups the user has belonged to.
3656 * The user may still belong to the returned groups. Compare with getGroups().
3658 * The function will not return groups the user had belonged to before MW 1.17
3660 * @return array Names of the groups the user has belonged to.
3662 public function getFormerGroups() {
3665 if ( is_null( $this->mFormerGroups
) ) {
3666 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3667 ?
wfGetDB( DB_MASTER
)
3668 : wfGetDB( DB_REPLICA
);
3669 $res = $db->select( 'user_former_groups',
3671 [ 'ufg_user' => $this->mId
],
3673 $this->mFormerGroups
= [];
3674 foreach ( $res as $row ) {
3675 $this->mFormerGroups
[] = $row->ufg_group
;
3679 return $this->mFormerGroups
;
3683 * Get the user's edit count.
3684 * @return int|null Null for anonymous users
3686 public function getEditCount() {
3687 if ( !$this->getId() ) {
3691 if ( $this->mEditCount
=== null ) {
3692 /* Populate the count, if it has not been populated yet */
3693 $dbr = wfGetDB( DB_REPLICA
);
3694 // check if the user_editcount field has been initialized
3695 $count = $dbr->selectField(
3696 'user', 'user_editcount',
3697 [ 'user_id' => $this->mId
],
3701 if ( $count === null ) {
3702 // it has not been initialized. do so.
3703 $count = $this->initEditCountInternal();
3705 $this->mEditCount
= $count;
3707 return (int)$this->mEditCount
;
3711 * Add the user to the given group. This takes immediate effect.
3712 * If the user is already in the group, the expiry time will be updated to the new
3713 * expiry time. (If $expiry is omitted or null, the membership will be altered to
3716 * @param string $group Name of the group to add
3717 * @param string|null $expiry Optional expiry timestamp in any format acceptable to
3718 * wfTimestamp(), or null if the group assignment should not expire
3721 public function addGroup( $group, $expiry = null ) {
3723 $this->loadGroups();
3726 $expiry = wfTimestamp( TS_MW
, $expiry );
3729 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
3733 // create the new UserGroupMembership and put it in the DB
3734 $ugm = new UserGroupMembership( $this->mId
, $group, $expiry );
3735 if ( !$ugm->insert( true ) ) {
3739 $this->mGroupMemberships
[$group] = $ugm;
3741 // Refresh the groups caches, and clear the rights cache so it will be
3742 // refreshed on the next call to $this->getRights().
3743 $this->getEffectiveGroups( true );
3744 $this->mRights
= null;
3746 $this->invalidateCache();
3752 * Remove the user from the given group.
3753 * This takes immediate effect.
3754 * @param string $group Name of the group to remove
3757 public function removeGroup( $group ) {
3760 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3764 $ugm = UserGroupMembership
::getMembership( $this->mId
, $group );
3765 // delete the membership entry
3766 if ( !$ugm ||
!$ugm->delete() ) {
3770 $this->loadGroups();
3771 unset( $this->mGroupMemberships
[$group] );
3773 // Refresh the groups caches, and clear the rights cache so it will be
3774 // refreshed on the next call to $this->getRights().
3775 $this->getEffectiveGroups( true );
3776 $this->mRights
= null;
3778 $this->invalidateCache();
3784 * Get whether the user is logged in
3787 public function isLoggedIn() {
3788 return $this->getId() != 0;
3792 * Get whether the user is anonymous
3795 public function isAnon() {
3796 return !$this->isLoggedIn();
3800 * @return bool Whether this user is flagged as being a bot role account
3803 public function isBot() {
3804 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3809 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3815 * Check if user is allowed to access a feature / make an action
3817 * @param string $permissions,... Permissions to test
3818 * @return bool True if user is allowed to perform *any* of the given actions
3820 public function isAllowedAny() {
3821 $permissions = func_get_args();
3822 foreach ( $permissions as $permission ) {
3823 if ( $this->isAllowed( $permission ) ) {
3832 * @param string $permissions,... Permissions to test
3833 * @return bool True if the user is allowed to perform *all* of the given actions
3835 public function isAllowedAll() {
3836 $permissions = func_get_args();
3837 foreach ( $permissions as $permission ) {
3838 if ( !$this->isAllowed( $permission ) ) {
3846 * Internal mechanics of testing a permission
3847 * @param string $action
3850 public function isAllowed( $action = '' ) {
3851 if ( $action === '' ) {
3852 return true; // In the spirit of DWIM
3854 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3855 // by misconfiguration: 0 == 'foo'
3856 return in_array( $action, $this->getRights(), true );
3860 * Check whether to enable recent changes patrol features for this user
3861 * @return bool True or false
3863 public function useRCPatrol() {
3864 global $wgUseRCPatrol;
3865 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3869 * Check whether to enable new pages patrol features for this user
3870 * @return bool True or false
3872 public function useNPPatrol() {
3873 global $wgUseRCPatrol, $wgUseNPPatrol;
3875 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3876 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3881 * Check whether to enable new files patrol features for this user
3882 * @return bool True or false
3884 public function useFilePatrol() {
3885 global $wgUseRCPatrol, $wgUseFilePatrol;
3887 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3888 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3893 * Get the WebRequest object to use with this object
3895 * @return WebRequest
3897 public function getRequest() {
3898 if ( $this->mRequest
) {
3899 return $this->mRequest
;
3907 * Check the watched status of an article.
3908 * @since 1.22 $checkRights parameter added
3909 * @param Title $title Title of the article to look at
3910 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3911 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3914 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3915 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3916 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3923 * @since 1.22 $checkRights parameter added
3924 * @param Title $title Title of the article to look at
3925 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3926 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3928 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3929 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3930 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3932 [ $title->getSubjectPage(), $title->getTalkPage() ]
3935 $this->invalidateCache();
3939 * Stop watching an article.
3940 * @since 1.22 $checkRights parameter added
3941 * @param Title $title Title of the article to look at
3942 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3943 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3945 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3946 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3947 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3948 $store->removeWatch( $this, $title->getSubjectPage() );
3949 $store->removeWatch( $this, $title->getTalkPage() );
3951 $this->invalidateCache();
3955 * Clear the user's notification timestamp for the given title.
3956 * If e-notif e-mails are on, they will receive notification mails on
3957 * the next change of the page if it's watched etc.
3958 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3959 * @param Title &$title Title of the article to look at
3960 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3962 public function clearNotification( &$title, $oldid = 0 ) {
3963 global $wgUseEnotif, $wgShowUpdatedMarker;
3965 // Do nothing if the database is locked to writes
3966 if ( wfReadOnly() ) {
3970 // Do nothing if not allowed to edit the watchlist
3971 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3975 // If we're working on user's talk page, we should update the talk page message indicator
3976 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3977 // Avoid PHP 7.1 warning of passing $this by reference
3979 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
3983 // Try to update the DB post-send and only if needed...
3984 DeferredUpdates
::addCallableUpdate( function () use ( $title, $oldid ) {
3985 if ( !$this->getNewtalk() ) {
3986 return; // no notifications to clear
3989 // Delete the last notifications (they stack up)
3990 $this->setNewtalk( false );
3992 // If there is a new, unseen, revision, use its timestamp
3994 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
3997 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
4002 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4006 if ( $this->isAnon() ) {
4007 // Nothing else to do...
4011 // Only update the timestamp if the page is being watched.
4012 // The query to find out if it is watched is cached both in memcached and per-invocation,
4013 // and when it does have to be executed, it can be on a replica DB
4014 // If this is the user's newtalk page, we always update the timestamp
4016 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
4020 MediaWikiServices
::getInstance()->getWatchedItemStore()
4021 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
4025 * Resets all of the given user's page-change notification timestamps.
4026 * If e-notif e-mails are on, they will receive notification mails on
4027 * the next change of any watched page.
4028 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
4030 public function clearAllNotifications() {
4031 global $wgUseEnotif, $wgShowUpdatedMarker;
4032 // Do nothing if not allowed to edit the watchlist
4033 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
4037 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4038 $this->setNewtalk( false );
4042 $id = $this->getId();
4047 $watchedItemStore = MediaWikiServices
::getInstance()->getWatchedItemStore();
4048 $watchedItemStore->resetAllNotificationTimestampsForUser( $this );
4050 // We also need to clear here the "you have new message" notification for the own
4051 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
4055 * Compute experienced level based on edit count and registration date.
4057 * @return string 'newcomer', 'learner', or 'experienced'
4059 public function getExperienceLevel() {
4060 global $wgLearnerEdits,
4061 $wgExperiencedUserEdits,
4062 $wgLearnerMemberSince,
4063 $wgExperiencedUserMemberSince;
4065 if ( $this->isAnon() ) {
4069 $editCount = $this->getEditCount();
4070 $registration = $this->getRegistration();
4072 $learnerRegistration = wfTimestamp( TS_MW
, $now - $wgLearnerMemberSince * 86400 );
4073 $experiencedRegistration = wfTimestamp( TS_MW
, $now - $wgExperiencedUserMemberSince * 86400 );
4075 if ( $editCount < $wgLearnerEdits ||
4076 $registration > $learnerRegistration ) {
4080 if ( $editCount > $wgExperiencedUserEdits &&
4081 $registration <= $experiencedRegistration
4083 return 'experienced';
4090 * Persist this user's session (e.g. set cookies)
4092 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
4094 * @param bool|null $secure Whether to force secure/insecure cookies or use default
4095 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
4097 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
4099 if ( $this->mId
== 0 ) {
4103 $session = $this->getRequest()->getSession();
4104 if ( $request && $session->getRequest() !== $request ) {
4105 $session = $session->sessionWithRequest( $request );
4107 $delay = $session->delaySave();
4109 if ( !$session->getUser()->equals( $this ) ) {
4110 if ( !$session->canSetUser() ) {
4111 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4112 ->warning( __METHOD__
.
4113 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
4117 $session->setUser( $this );
4120 $session->setRememberUser( $rememberMe );
4121 if ( $secure !== null ) {
4122 $session->setForceHTTPS( $secure );
4125 $session->persist();
4127 ScopedCallback
::consume( $delay );
4131 * Log this user out.
4133 public function logout() {
4134 // Avoid PHP 7.1 warning of passing $this by reference
4136 if ( Hooks
::run( 'UserLogout', [ &$user ] ) ) {
4142 * Clear the user's session, and reset the instance cache.
4145 public function doLogout() {
4146 $session = $this->getRequest()->getSession();
4147 if ( !$session->canSetUser() ) {
4148 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4149 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
4150 $error = 'immutable';
4151 } elseif ( !$session->getUser()->equals( $this ) ) {
4152 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4153 ->warning( __METHOD__
.
4154 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
4156 // But we still may as well make this user object anon
4157 $this->clearInstanceCache( 'defaults' );
4158 $error = 'wronguser';
4160 $this->clearInstanceCache( 'defaults' );
4161 $delay = $session->delaySave();
4162 $session->unpersist(); // Clear cookies (T127436)
4163 $session->setLoggedOutTimestamp( time() );
4164 $session->setUser( new User
);
4165 $session->set( 'wsUserID', 0 ); // Other code expects this
4166 $session->resetAllTokens();
4167 ScopedCallback
::consume( $delay );
4170 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
4171 'event' => 'logout',
4172 'successful' => $error === false,
4173 'status' => $error ?
: 'success',
4178 * Save this user's settings into the database.
4179 * @todo Only rarely do all these fields need to be set!
4181 public function saveSettings() {
4182 if ( wfReadOnly() ) {
4183 // @TODO: caller should deal with this instead!
4184 // This should really just be an exception.
4185 MWExceptionHandler
::logException( new DBExpectedError(
4187 "Could not update user with ID '{$this->mId}'; DB is read-only."
4193 if ( $this->mId
== 0 ) {
4197 // Get a new user_touched that is higher than the old one.
4198 // This will be used for a CAS check as a last-resort safety
4199 // check against race conditions and replica DB lag.
4200 $newTouched = $this->newTouchedTimestamp();
4202 $dbw = wfGetDB( DB_MASTER
);
4203 $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $newTouched ) {
4204 global $wgActorTableSchemaMigrationStage;
4206 $dbw->update( 'user',
4208 'user_name' => $this->mName
,
4209 'user_real_name' => $this->mRealName
,
4210 'user_email' => $this->mEmail
,
4211 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4212 'user_touched' => $dbw->timestamp( $newTouched ),
4213 'user_token' => strval( $this->mToken
),
4214 'user_email_token' => $this->mEmailToken
,
4215 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
4216 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
4217 'user_id' => $this->mId
,
4221 if ( !$dbw->affectedRows() ) {
4222 // Maybe the problem was a missed cache update; clear it to be safe
4223 $this->clearSharedCache( 'refresh' );
4224 // User was changed in the meantime or loaded with stale data
4225 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
4226 LoggerFactory
::getInstance( 'preferences' )->warning(
4227 "CAS update failed on user_touched for user ID '{user_id}' ({db_flag} read)",
4228 [ 'user_id' => $this->mId
, 'db_flag' => $from ]
4230 throw new MWException( "CAS update failed on user_touched. " .
4231 "The version of the user to be saved is older than the current version."
4235 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4238 [ 'actor_name' => $this->mName
],
4239 [ 'actor_user' => $this->mId
],
4245 $this->mTouched
= $newTouched;
4246 $this->saveOptions();
4248 Hooks
::run( 'UserSaveSettings', [ $this ] );
4249 $this->clearSharedCache();
4250 $this->getUserPage()->purgeSquid();
4254 * If only this user's username is known, and it exists, return the user ID.
4256 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
4259 public function idForName( $flags = 0 ) {
4260 $s = trim( $this->getName() );
4265 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
4266 ?
wfGetDB( DB_MASTER
)
4267 : wfGetDB( DB_REPLICA
);
4269 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
4270 ?
[ 'LOCK IN SHARE MODE' ]
4273 $id = $db->selectField( 'user',
4274 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
4280 * Add a user to the database, return the user object
4282 * @param string $name Username to add
4283 * @param array $params Array of Strings Non-default parameters to save to
4284 * the database as user_* fields:
4285 * - email: The user's email address.
4286 * - email_authenticated: The email authentication timestamp.
4287 * - real_name: The user's real name.
4288 * - options: An associative array of non-default options.
4289 * - token: Random authentication token. Do not set.
4290 * - registration: Registration timestamp. Do not set.
4292 * @return User|null User object, or null if the username already exists.
4294 public static function createNew( $name, $params = [] ) {
4295 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
4296 if ( isset( $params[$field] ) ) {
4297 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
4298 unset( $params[$field] );
4304 $user->setToken(); // init token
4305 if ( isset( $params['options'] ) ) {
4306 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
4307 unset( $params['options'] );
4309 $dbw = wfGetDB( DB_MASTER
);
4311 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4314 'user_name' => $name,
4315 'user_password' => $noPass,
4316 'user_newpassword' => $noPass,
4317 'user_email' => $user->mEmail
,
4318 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
4319 'user_real_name' => $user->mRealName
,
4320 'user_token' => strval( $user->mToken
),
4321 'user_registration' => $dbw->timestamp( $user->mRegistration
),
4322 'user_editcount' => 0,
4323 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4325 foreach ( $params as $name => $value ) {
4326 $fields["user_$name"] = $value;
4329 return $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $fields ) {
4330 $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
4331 if ( $dbw->affectedRows() ) {
4332 $newUser = self
::newFromId( $dbw->insertId() );
4333 $newUser->mName
= $fields['user_name'];
4334 $newUser->updateActorId( $dbw );
4335 // Load the user from master to avoid replica lag
4336 $newUser->load( self
::READ_LATEST
);
4345 * Add this existing user object to the database. If the user already
4346 * exists, a fatal status object is returned, and the user object is
4347 * initialised with the data from the database.
4349 * Previously, this function generated a DB error due to a key conflict
4350 * if the user already existed. Many extension callers use this function
4351 * in code along the lines of:
4353 * $user = User::newFromName( $name );
4354 * if ( !$user->isLoggedIn() ) {
4355 * $user->addToDatabase();
4357 * // do something with $user...
4359 * However, this was vulnerable to a race condition (T18020). By
4360 * initialising the user object if the user exists, we aim to support this
4361 * calling sequence as far as possible.
4363 * Note that if the user exists, this function will acquire a write lock,
4364 * so it is still advisable to make the call conditional on isLoggedIn(),
4365 * and to commit the transaction after calling.
4367 * @throws MWException
4370 public function addToDatabase() {
4372 if ( !$this->mToken
) {
4373 $this->setToken(); // init token
4376 if ( !is_string( $this->mName
) ) {
4377 throw new RuntimeException( "User name field is not set." );
4380 $this->mTouched
= $this->newTouchedTimestamp();
4382 $dbw = wfGetDB( DB_MASTER
);
4383 $status = $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) {
4384 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4385 $dbw->insert( 'user',
4387 'user_name' => $this->mName
,
4388 'user_password' => $noPass,
4389 'user_newpassword' => $noPass,
4390 'user_email' => $this->mEmail
,
4391 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4392 'user_real_name' => $this->mRealName
,
4393 'user_token' => strval( $this->mToken
),
4394 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4395 'user_editcount' => 0,
4396 'user_touched' => $dbw->timestamp( $this->mTouched
),
4400 if ( !$dbw->affectedRows() ) {
4401 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4402 $this->mId
= $dbw->selectField(
4405 [ 'user_name' => $this->mName
],
4407 [ 'LOCK IN SHARE MODE' ]
4410 if ( $this->mId
&& $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4414 throw new MWException( $fname . ": hit a key conflict attempting " .
4415 "to insert user '{$this->mName}' row, but it was not present in select!" );
4417 return Status
::newFatal( 'userexists' );
4419 $this->mId
= $dbw->insertId();
4420 self
::$idCacheByName[$this->mName
] = $this->mId
;
4421 $this->updateActorId( $dbw );
4423 return Status
::newGood();
4425 if ( !$status->isGood() ) {
4429 // Clear instance cache other than user table data and actor, which is already accurate
4430 $this->clearInstanceCache();
4432 $this->saveOptions();
4433 return Status
::newGood();
4437 * Update the actor ID after an insert
4438 * @param IDatabase $dbw Writable database handle
4440 private function updateActorId( IDatabase
$dbw ) {
4441 global $wgActorTableSchemaMigrationStage;
4443 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4446 [ 'actor_user' => $this->mId
, 'actor_name' => $this->mName
],
4449 $this->mActorId
= (int)$dbw->insertId();
4454 * If this user is logged-in and blocked,
4455 * block any IP address they've successfully logged in from.
4456 * @return bool A block was spread
4458 public function spreadAnyEditBlock() {
4459 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4460 return $this->spreadBlock();
4467 * If this (non-anonymous) user is blocked,
4468 * block the IP address they've successfully logged in from.
4469 * @return bool A block was spread
4471 protected function spreadBlock() {
4472 wfDebug( __METHOD__
. "()\n" );
4474 if ( $this->mId
== 0 ) {
4478 $userblock = Block
::newFromTarget( $this->getName() );
4479 if ( !$userblock ) {
4483 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4487 * Get whether the user is explicitly blocked from account creation.
4488 * @return bool|Block
4490 public function isBlockedFromCreateAccount() {
4491 $this->getBlockedStatus();
4492 if ( $this->mBlock
&& $this->mBlock
->appliesToRight( 'createaccount' ) ) {
4493 return $this->mBlock
;
4496 # T15611: if the IP address the user is trying to create an account from is
4497 # blocked with createaccount disabled, prevent new account creation there even
4498 # when the user is logged in
4499 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4500 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4502 return $this->mBlockedFromCreateAccount
instanceof Block
4503 && $this->mBlockedFromCreateAccount
->appliesToRight( 'createaccount' )
4504 ?
$this->mBlockedFromCreateAccount
4509 * Get whether the user is blocked from using Special:Emailuser.
4512 public function isBlockedFromEmailuser() {
4513 $this->getBlockedStatus();
4514 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'sendemail' );
4518 * Get whether the user is blocked from using Special:Upload
4523 public function isBlockedFromUpload() {
4524 $this->getBlockedStatus();
4525 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'upload' );
4529 * Get whether the user is allowed to create an account.
4532 public function isAllowedToCreateAccount() {
4533 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4537 * Get this user's personal page title.
4539 * @return Title User's personal page title
4541 public function getUserPage() {
4542 return Title
::makeTitle( NS_USER
, $this->getName() );
4546 * Get this user's talk page title.
4548 * @return Title User's talk page title
4550 public function getTalkPage() {
4551 $title = $this->getUserPage();
4552 return $title->getTalkPage();
4556 * Determine whether the user is a newbie. Newbies are either
4557 * anonymous IPs, or the most recently created accounts.
4560 public function isNewbie() {
4561 return !$this->isAllowed( 'autoconfirmed' );
4565 * Check to see if the given clear-text password is one of the accepted passwords
4566 * @deprecated since 1.27, use AuthManager instead
4567 * @param string $password User password
4568 * @return bool True if the given password is correct, otherwise False
4570 public function checkPassword( $password ) {
4571 wfDeprecated( __METHOD__
, '1.27' );
4573 $manager = AuthManager
::singleton();
4574 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4575 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4577 'username' => $this->getName(),
4578 'password' => $password,
4581 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4582 switch ( $res->status
) {
4583 case AuthenticationResponse
::PASS
:
4585 case AuthenticationResponse
::FAIL
:
4586 // Hope it's not a PreAuthenticationProvider that failed...
4587 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4588 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4591 throw new BadMethodCallException(
4592 'AuthManager returned a response unsupported by ' . __METHOD__
4598 * Check if the given clear-text password matches the temporary password
4599 * sent by e-mail for password reset operations.
4601 * @deprecated since 1.27, use AuthManager instead
4602 * @param string $plaintext
4603 * @return bool True if matches, false otherwise
4605 public function checkTemporaryPassword( $plaintext ) {
4606 wfDeprecated( __METHOD__
, '1.27' );
4607 // Can't check the temporary password individually.
4608 return $this->checkPassword( $plaintext );
4612 * Initialize (if necessary) and return a session token value
4613 * which can be used in edit forms to show that the user's
4614 * login credentials aren't being hijacked with a foreign form
4618 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4619 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4620 * @return MediaWiki\Session\Token The new edit token
4622 public function getEditTokenObject( $salt = '', $request = null ) {
4623 if ( $this->isAnon() ) {
4624 return new LoggedOutEditToken();
4628 $request = $this->getRequest();
4630 return $request->getSession()->getToken( $salt );
4634 * Initialize (if necessary) and return a session token value
4635 * which can be used in edit forms to show that the user's
4636 * login credentials aren't being hijacked with a foreign form
4639 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4642 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4643 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4644 * @return string The new edit token
4646 public function getEditToken( $salt = '', $request = null ) {
4647 return $this->getEditTokenObject( $salt, $request )->toString();
4651 * Check given value against the token value stored in the session.
4652 * A match should confirm that the form was submitted from the
4653 * user's own login session, not a form submission from a third-party
4656 * @param string $val Input value to compare
4657 * @param string|array $salt Optional function-specific data for hashing
4658 * @param WebRequest|null $request Object to use or null to use $wgRequest
4659 * @param int|null $maxage Fail tokens older than this, in seconds
4660 * @return bool Whether the token matches
4662 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4663 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4667 * Check given value against the token value stored in the session,
4668 * ignoring the suffix.
4670 * @param string $val Input value to compare
4671 * @param string|array $salt Optional function-specific data for hashing
4672 * @param WebRequest|null $request Object to use or null to use $wgRequest
4673 * @param int|null $maxage Fail tokens older than this, in seconds
4674 * @return bool Whether the token matches
4676 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4677 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4678 return $this->matchEditToken( $val, $salt, $request, $maxage );
4682 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4683 * mail to the user's given address.
4685 * @param string $type Message to send, either "created", "changed" or "set"
4688 public function sendConfirmationMail( $type = 'created' ) {
4690 $expiration = null; // gets passed-by-ref and defined in next line.
4691 $token = $this->confirmationToken( $expiration );
4692 $url = $this->confirmationTokenUrl( $token );
4693 $invalidateURL = $this->invalidationTokenUrl( $token );
4694 $this->saveSettings();
4696 if ( $type == 'created' ||
$type === false ) {
4697 $message = 'confirmemail_body';
4699 } elseif ( $type === true ) {
4700 $message = 'confirmemail_body_changed';
4703 // Messages: confirmemail_body_changed, confirmemail_body_set
4704 $message = 'confirmemail_body_' . $type;
4708 'subject' => wfMessage( 'confirmemail_subject' )->text(),
4709 'body' => wfMessage( $message,
4710 $this->getRequest()->getIP(),
4713 $wgLang->userTimeAndDate( $expiration, $this ),
4715 $wgLang->userDate( $expiration, $this ),
4716 $wgLang->userTime( $expiration, $this ) )->text(),
4722 'ip' => $this->getRequest()->getIP(),
4723 'confirmURL' => $url,
4724 'invalidateURL' => $invalidateURL,
4725 'expiration' => $expiration
4728 Hooks
::run( 'UserSendConfirmationMail', [ $this, &$mail, $info ] );
4729 return $this->sendMail( $mail['subject'], $mail['body'], $mail['from'], $mail['replyTo'] );
4733 * Send an e-mail to this user's account. Does not check for
4734 * confirmed status or validity.
4736 * @param string $subject Message subject
4737 * @param string $body Message body
4738 * @param User|null $from Optional sending user; if unspecified, default
4739 * $wgPasswordSender will be used.
4740 * @param MailAddress|null $replyto Reply-To address
4743 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4744 global $wgPasswordSender;
4746 if ( $from instanceof User
) {
4747 $sender = MailAddress
::newFromUser( $from );
4749 $sender = new MailAddress( $wgPasswordSender,
4750 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4752 $to = MailAddress
::newFromUser( $this );
4754 return UserMailer
::send( $to, $sender, $subject, $body, [
4755 'replyTo' => $replyto,
4760 * Generate, store, and return a new e-mail confirmation code.
4761 * A hash (unsalted, since it's used as a key) is stored.
4763 * @note Call saveSettings() after calling this function to commit
4764 * this change to the database.
4766 * @param string &$expiration Accepts the expiration time
4767 * @return string New token
4769 protected function confirmationToken( &$expiration ) {
4770 global $wgUserEmailConfirmationTokenExpiry;
4772 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4773 $expiration = wfTimestamp( TS_MW
, $expires );
4775 $token = MWCryptRand
::generateHex( 32 );
4776 $hash = md5( $token );
4777 $this->mEmailToken
= $hash;
4778 $this->mEmailTokenExpires
= $expiration;
4783 * Return a URL the user can use to confirm their email address.
4784 * @param string $token Accepts the email confirmation token
4785 * @return string New token URL
4787 protected function confirmationTokenUrl( $token ) {
4788 return $this->getTokenUrl( 'ConfirmEmail', $token );
4792 * Return a URL the user can use to invalidate their email address.
4793 * @param string $token Accepts the email confirmation token
4794 * @return string New token URL
4796 protected function invalidationTokenUrl( $token ) {
4797 return $this->getTokenUrl( 'InvalidateEmail', $token );
4801 * Internal function to format the e-mail validation/invalidation URLs.
4802 * This uses a quickie hack to use the
4803 * hardcoded English names of the Special: pages, for ASCII safety.
4805 * @note Since these URLs get dropped directly into emails, using the
4806 * short English names avoids insanely long URL-encoded links, which
4807 * also sometimes can get corrupted in some browsers/mailers
4808 * (T8957 with Gmail and Internet Explorer).
4810 * @param string $page Special page
4811 * @param string $token
4812 * @return string Formatted URL
4814 protected function getTokenUrl( $page, $token ) {
4815 // Hack to bypass localization of 'Special:'
4816 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4817 return $title->getCanonicalURL();
4821 * Mark the e-mail address confirmed.
4823 * @note Call saveSettings() after calling this function to commit the change.
4827 public function confirmEmail() {
4828 // Check if it's already confirmed, so we don't touch the database
4829 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4830 if ( !$this->isEmailConfirmed() ) {
4831 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4832 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4838 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4839 * address if it was already confirmed.
4841 * @note Call saveSettings() after calling this function to commit the change.
4842 * @return bool Returns true
4844 public function invalidateEmail() {
4846 $this->mEmailToken
= null;
4847 $this->mEmailTokenExpires
= null;
4848 $this->setEmailAuthenticationTimestamp( null );
4850 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4855 * Set the e-mail authentication timestamp.
4856 * @param string $timestamp TS_MW timestamp
4858 public function setEmailAuthenticationTimestamp( $timestamp ) {
4860 $this->mEmailAuthenticated
= $timestamp;
4861 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4865 * Is this user allowed to send e-mails within limits of current
4866 * site configuration?
4869 public function canSendEmail() {
4870 global $wgEnableEmail, $wgEnableUserEmail;
4871 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4874 $canSend = $this->isEmailConfirmed();
4875 // Avoid PHP 7.1 warning of passing $this by reference
4877 Hooks
::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
4882 * Is this user allowed to receive e-mails within limits of current
4883 * site configuration?
4886 public function canReceiveEmail() {
4887 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4891 * Is this user's e-mail address valid-looking and confirmed within
4892 * limits of the current site configuration?
4894 * @note If $wgEmailAuthentication is on, this may require the user to have
4895 * confirmed their address by returning a code or using a password
4896 * sent to the address from the wiki.
4900 public function isEmailConfirmed() {
4901 global $wgEmailAuthentication;
4903 // Avoid PHP 7.1 warning of passing $this by reference
4906 if ( Hooks
::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
4907 if ( $this->isAnon() ) {
4910 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4913 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4923 * Check whether there is an outstanding request for e-mail confirmation.
4926 public function isEmailConfirmationPending() {
4927 global $wgEmailAuthentication;
4928 return $wgEmailAuthentication &&
4929 !$this->isEmailConfirmed() &&
4930 $this->mEmailToken
&&
4931 $this->mEmailTokenExpires
> wfTimestamp();
4935 * Get the timestamp of account creation.
4937 * @return string|bool|null Timestamp of account creation, false for
4938 * non-existent/anonymous user accounts, or null if existing account
4939 * but information is not in database.
4941 public function getRegistration() {
4942 if ( $this->isAnon() ) {
4946 return $this->mRegistration
;
4950 * Get the timestamp of the first edit
4952 * @return string|bool Timestamp of first edit, or false for
4953 * non-existent/anonymous user accounts.
4955 public function getFirstEditTimestamp() {
4956 return $this->getEditTimestamp( true );
4960 * Get the timestamp of the latest edit
4963 * @return string|bool Timestamp of first edit, or false for
4964 * non-existent/anonymous user accounts.
4966 public function getLatestEditTimestamp() {
4967 return $this->getEditTimestamp( false );
4971 * Get the timestamp of the first or latest edit
4973 * @param bool $first True for the first edit, false for the latest one
4974 * @return string|bool Timestamp of first or latest edit, or false for
4975 * non-existent/anonymous user accounts.
4977 private function getEditTimestamp( $first ) {
4978 if ( $this->getId() == 0 ) {
4979 return false; // anons
4981 $dbr = wfGetDB( DB_REPLICA
);
4982 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
4983 $tsField = isset( $actorWhere['tables']['temp_rev_user'] )
4984 ?
'revactor_timestamp' : 'rev_timestamp';
4985 $sortOrder = $first ?
'ASC' : 'DESC';
4986 $time = $dbr->selectField(
4987 [ 'revision' ] +
$actorWhere['tables'],
4989 [ $actorWhere['conds'] ],
4991 [ 'ORDER BY' => "$tsField $sortOrder" ],
4992 $actorWhere['joins']
4995 return false; // no edits
4997 return wfTimestamp( TS_MW
, $time );
5001 * Get the permissions associated with a given list of groups
5003 * @param array $groups Array of Strings List of internal group names
5004 * @return array Array of Strings List of permission key names for given groups combined
5006 public static function getGroupPermissions( $groups ) {
5007 global $wgGroupPermissions, $wgRevokePermissions;
5009 // grant every granted permission first
5010 foreach ( $groups as $group ) {
5011 if ( isset( $wgGroupPermissions[$group] ) ) {
5012 $rights = array_merge( $rights,
5013 // array_filter removes empty items
5014 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
5017 // now revoke the revoked permissions
5018 foreach ( $groups as $group ) {
5019 if ( isset( $wgRevokePermissions[$group] ) ) {
5020 $rights = array_diff( $rights,
5021 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
5024 return array_unique( $rights );
5028 * Get all the groups who have a given permission
5030 * @param string $role Role to check
5031 * @return array Array of Strings List of internal group names with the given permission
5033 public static function getGroupsWithPermission( $role ) {
5034 global $wgGroupPermissions;
5035 $allowedGroups = [];
5036 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
5037 if ( self
::groupHasPermission( $group, $role ) ) {
5038 $allowedGroups[] = $group;
5041 return $allowedGroups;
5045 * Check, if the given group has the given permission
5047 * If you're wanting to check whether all users have a permission, use
5048 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
5052 * @param string $group Group to check
5053 * @param string $role Role to check
5056 public static function groupHasPermission( $group, $role ) {
5057 global $wgGroupPermissions, $wgRevokePermissions;
5058 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
5059 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
5063 * Check if all users may be assumed to have the given permission
5065 * We generally assume so if the right is granted to '*' and isn't revoked
5066 * on any group. It doesn't attempt to take grants or other extension
5067 * limitations on rights into account in the general case, though, as that
5068 * would require it to always return false and defeat the purpose.
5069 * Specifically, session-based rights restrictions (such as OAuth or bot
5070 * passwords) are applied based on the current session.
5073 * @param string $right Right to check
5076 public static function isEveryoneAllowed( $right ) {
5077 global $wgGroupPermissions, $wgRevokePermissions;
5080 // Use the cached results, except in unit tests which rely on
5081 // being able change the permission mid-request
5082 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
5083 return $cache[$right];
5086 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
5087 $cache[$right] = false;
5091 // If it's revoked anywhere, then everyone doesn't have it
5092 foreach ( $wgRevokePermissions as $rights ) {
5093 if ( isset( $rights[$right] ) && $rights[$right] ) {
5094 $cache[$right] = false;
5099 // Remove any rights that aren't allowed to the global-session user,
5100 // unless there are no sessions for this endpoint.
5101 if ( !defined( 'MW_NO_SESSION' ) ) {
5102 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
5103 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
5104 $cache[$right] = false;
5109 // Allow extensions to say false
5110 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
5111 $cache[$right] = false;
5115 $cache[$right] = true;
5120 * Return the set of defined explicit groups.
5121 * The implicit groups (by default *, 'user' and 'autoconfirmed')
5122 * are not included, as they are defined automatically, not in the database.
5123 * @return array Array of internal group names
5125 public static function getAllGroups() {
5126 global $wgGroupPermissions, $wgRevokePermissions;
5127 return array_values( array_diff(
5128 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
5129 self
::getImplicitGroups()
5134 * Get a list of all available permissions.
5135 * @return string[] Array of permission names
5137 public static function getAllRights() {
5138 if ( self
::$mAllRights === false ) {
5139 global $wgAvailableRights;
5140 if ( count( $wgAvailableRights ) ) {
5141 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
5143 self
::$mAllRights = self
::$mCoreRights;
5145 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
5147 return self
::$mAllRights;
5151 * Get a list of implicit groups
5152 * TODO: Should we deprecate this? It's trivial, but we don't want to encourage use of globals.
5154 * @return array Array of Strings Array of internal group names
5156 public static function getImplicitGroups() {
5157 global $wgImplicitGroups;
5158 return $wgImplicitGroups;
5162 * Get the title of a page describing a particular group
5163 * @deprecated since 1.29 Use UserGroupMembership::getGroupPage instead
5165 * @param string $group Internal group name
5166 * @return Title|bool Title of the page if it exists, false otherwise
5168 public static function getGroupPage( $group ) {
5169 wfDeprecated( __METHOD__
, '1.29' );
5170 return UserGroupMembership
::getGroupPage( $group );
5174 * Create a link to the group in HTML, if available;
5175 * else return the group name.
5176 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5177 * make the link yourself if you need custom text
5179 * @param string $group Internal name of the group
5180 * @param string $text The text of the link
5181 * @return string HTML link to the group
5183 public static function makeGroupLinkHTML( $group, $text = '' ) {
5184 wfDeprecated( __METHOD__
, '1.29' );
5186 if ( $text == '' ) {
5187 $text = UserGroupMembership
::getGroupName( $group );
5189 $title = UserGroupMembership
::getGroupPage( $group );
5191 return MediaWikiServices
::getInstance()
5192 ->getLinkRenderer()->makeLink( $title, $text );
5195 return htmlspecialchars( $text );
5199 * Create a link to the group in Wikitext, if available;
5200 * else return the group name.
5201 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5202 * make the link yourself if you need custom text
5204 * @param string $group Internal name of the group
5205 * @param string $text The text of the link
5206 * @return string Wikilink to the group
5208 public static function makeGroupLinkWiki( $group, $text = '' ) {
5209 wfDeprecated( __METHOD__
, '1.29' );
5211 if ( $text == '' ) {
5212 $text = UserGroupMembership
::getGroupName( $group );
5214 $title = UserGroupMembership
::getGroupPage( $group );
5216 $page = $title->getFullText();
5217 return "[[$page|$text]]";
5224 * Returns an array of the groups that a particular group can add/remove.
5226 * @param string $group The group to check for whether it can add/remove
5227 * @return array Array( 'add' => array( addablegroups ),
5228 * 'remove' => array( removablegroups ),
5229 * 'add-self' => array( addablegroups to self),
5230 * 'remove-self' => array( removable groups from self) )
5232 public static function changeableByGroup( $group ) {
5233 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
5242 if ( empty( $wgAddGroups[$group] ) ) {
5243 // Don't add anything to $groups
5244 } elseif ( $wgAddGroups[$group] === true ) {
5245 // You get everything
5246 $groups['add'] = self
::getAllGroups();
5247 } elseif ( is_array( $wgAddGroups[$group] ) ) {
5248 $groups['add'] = $wgAddGroups[$group];
5251 // Same thing for remove
5252 if ( empty( $wgRemoveGroups[$group] ) ) {
5254 } elseif ( $wgRemoveGroups[$group] === true ) {
5255 $groups['remove'] = self
::getAllGroups();
5256 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
5257 $groups['remove'] = $wgRemoveGroups[$group];
5260 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
5261 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
5262 foreach ( $wgGroupsAddToSelf as $key => $value ) {
5263 if ( is_int( $key ) ) {
5264 $wgGroupsAddToSelf['user'][] = $value;
5269 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
5270 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
5271 if ( is_int( $key ) ) {
5272 $wgGroupsRemoveFromSelf['user'][] = $value;
5277 // Now figure out what groups the user can add to him/herself
5278 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
5280 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
5281 // No idea WHY this would be used, but it's there
5282 $groups['add-self'] = self
::getAllGroups();
5283 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
5284 $groups['add-self'] = $wgGroupsAddToSelf[$group];
5287 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
5289 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
5290 $groups['remove-self'] = self
::getAllGroups();
5291 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
5292 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
5299 * Returns an array of groups that this user can add and remove
5300 * @return array Array( 'add' => array( addablegroups ),
5301 * 'remove' => array( removablegroups ),
5302 * 'add-self' => array( addablegroups to self),
5303 * 'remove-self' => array( removable groups from self) )
5305 public function changeableGroups() {
5306 if ( $this->isAllowed( 'userrights' ) ) {
5307 // This group gives the right to modify everything (reverse-
5308 // compatibility with old "userrights lets you change
5310 // Using array_merge to make the groups reindexed
5311 $all = array_merge( self
::getAllGroups() );
5320 // Okay, it's not so simple, we will have to go through the arrays
5327 $addergroups = $this->getEffectiveGroups();
5329 foreach ( $addergroups as $addergroup ) {
5330 $groups = array_merge_recursive(
5331 $groups, $this->changeableByGroup( $addergroup )
5333 $groups['add'] = array_unique( $groups['add'] );
5334 $groups['remove'] = array_unique( $groups['remove'] );
5335 $groups['add-self'] = array_unique( $groups['add-self'] );
5336 $groups['remove-self'] = array_unique( $groups['remove-self'] );
5342 * Schedule a deferred update to update the user's edit count
5344 public function incEditCount() {
5345 if ( $this->isAnon() ) {
5349 DeferredUpdates
::addUpdate(
5350 new UserEditCountUpdate( $this, 1 ),
5351 DeferredUpdates
::POSTSEND
5356 * This method should not be called outside User/UserEditCountUpdate
5360 public function setEditCountInternal( $count ) {
5361 $this->mEditCount
= $count;
5365 * Initialize user_editcount from data out of the revision table
5367 * This method should not be called outside User/UserEditCountUpdate
5369 * @return int Number of edits
5371 public function initEditCountInternal() {
5372 // Pull from a replica DB to be less cruel to servers
5373 // Accuracy isn't the point anyway here
5374 $dbr = wfGetDB( DB_REPLICA
);
5375 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5376 $count = (int)$dbr->selectField(
5377 [ 'revision' ] +
$actorWhere['tables'],
5379 [ $actorWhere['conds'] ],
5382 $actorWhere['joins']
5385 $dbw = wfGetDB( DB_MASTER
);
5388 [ 'user_editcount' => $count ],
5390 'user_id' => $this->getId(),
5391 'user_editcount IS NULL OR user_editcount < ' . (int)$count
5400 * Get the description of a given right
5403 * @param string $right Right to query
5404 * @return string Localized description of the right
5406 public static function getRightDescription( $right ) {
5407 $key = "right-$right";
5408 $msg = wfMessage( $key );
5409 return $msg->isDisabled() ?
$right : $msg->text();
5413 * Get the name of a given grant
5416 * @param string $grant Grant to query
5417 * @return string Localized name of the grant
5419 public static function getGrantName( $grant ) {
5420 $key = "grant-$grant";
5421 $msg = wfMessage( $key );
5422 return $msg->isDisabled() ?
$grant : $msg->text();
5426 * Add a newuser log entry for this user.
5427 * Before 1.19 the return value was always true.
5429 * @deprecated since 1.27, AuthManager handles logging
5430 * @param string|bool $action Account creation type.
5431 * - String, one of the following values:
5432 * - 'create' for an anonymous user creating an account for himself.
5433 * This will force the action's performer to be the created user itself,
5434 * no matter the value of $wgUser
5435 * - 'create2' for a logged in user creating an account for someone else
5436 * - 'byemail' when the created user will receive its password by e-mail
5437 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5438 * - Boolean means whether the account was created by e-mail (deprecated):
5439 * - true will be converted to 'byemail'
5440 * - false will be converted to 'create' if this object is the same as
5441 * $wgUser and to 'create2' otherwise
5442 * @param string $reason User supplied reason
5445 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5446 return true; // disabled
5450 * Add an autocreate newuser log entry for this user
5451 * Used by things like CentralAuth and perhaps other authplugins.
5452 * Consider calling addNewUserLogEntry() directly instead.
5454 * @deprecated since 1.27, AuthManager handles logging
5457 public function addNewUserLogEntryAutoCreate() {
5458 $this->addNewUserLogEntry( 'autocreate' );
5464 * Load the user options either from cache, the database or an array
5466 * @param array|null $data Rows for the current user out of the user_properties table
5468 protected function loadOptions( $data = null ) {
5471 if ( $this->mOptionsLoaded
) {
5475 $this->mOptions
= self
::getDefaultOptions();
5477 if ( !$this->getId() ) {
5478 // For unlogged-in users, load language/variant options from request.
5479 // There's no need to do it for logged-in users: they can set preferences,
5480 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5481 // so don't override user's choice (especially when the user chooses site default).
5482 $variant = MediaWikiServices
::getInstance()->getContentLanguage()->getDefaultVariant();
5483 $this->mOptions
['variant'] = $variant;
5484 $this->mOptions
['language'] = $variant;
5485 $this->mOptionsLoaded
= true;
5489 // Maybe load from the object
5490 if ( !is_null( $this->mOptionOverrides
) ) {
5491 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5492 foreach ( $this->mOptionOverrides
as $key => $value ) {
5493 $this->mOptions
[$key] = $value;
5496 if ( !is_array( $data ) ) {
5497 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5498 // Load from database
5499 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5500 ?
wfGetDB( DB_MASTER
)
5501 : wfGetDB( DB_REPLICA
);
5503 $res = $dbr->select(
5505 [ 'up_property', 'up_value' ],
5506 [ 'up_user' => $this->getId() ],
5510 $this->mOptionOverrides
= [];
5512 foreach ( $res as $row ) {
5513 // Convert '0' to 0. PHP's boolean conversion considers them both
5514 // false, but e.g. JavaScript considers the former as true.
5515 // @todo: T54542 Somehow determine the desired type (string/int/bool)
5516 // and convert all values here.
5517 if ( $row->up_value
=== '0' ) {
5520 $data[$row->up_property
] = $row->up_value
;
5524 foreach ( $data as $property => $value ) {
5525 $this->mOptionOverrides
[$property] = $value;
5526 $this->mOptions
[$property] = $value;
5530 // Replace deprecated language codes
5531 $this->mOptions
['language'] = LanguageCode
::replaceDeprecatedCodes(
5532 $this->mOptions
['language']
5535 $this->mOptionsLoaded
= true;
5537 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5541 * Saves the non-default options for this user, as previously set e.g. via
5542 * setOption(), in the database's "user_properties" (preferences) table.
5543 * Usually used via saveSettings().
5545 protected function saveOptions() {
5546 $this->loadOptions();
5548 // Not using getOptions(), to keep hidden preferences in database
5549 $saveOptions = $this->mOptions
;
5551 // Allow hooks to abort, for instance to save to a global profile.
5552 // Reset options to default state before saving.
5553 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5557 $userId = $this->getId();
5559 $insert_rows = []; // all the new preference rows
5560 foreach ( $saveOptions as $key => $value ) {
5561 // Don't bother storing default values
5562 $defaultOption = self
::getDefaultOption( $key );
5563 if ( ( $defaultOption === null && $value !== false && $value !== null )
5564 ||
$value != $defaultOption
5567 'up_user' => $userId,
5568 'up_property' => $key,
5569 'up_value' => $value,
5574 $dbw = wfGetDB( DB_MASTER
);
5576 $res = $dbw->select( 'user_properties',
5577 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5579 // Find prior rows that need to be removed or updated. These rows will
5580 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5582 foreach ( $res as $row ) {
5583 if ( !isset( $saveOptions[$row->up_property
] )
5584 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5586 $keysDelete[] = $row->up_property
;
5590 if ( count( $keysDelete ) ) {
5591 // Do the DELETE by PRIMARY KEY for prior rows.
5592 // In the past a very large portion of calls to this function are for setting
5593 // 'rememberpassword' for new accounts (a preference that has since been removed).
5594 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5595 // caused gap locks on [max user ID,+infinity) which caused high contention since
5596 // updates would pile up on each other as they are for higher (newer) user IDs.
5597 // It might not be necessary these days, but it shouldn't hurt either.
5598 $dbw->delete( 'user_properties',
5599 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5601 // Insert the new preference rows
5602 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5606 * Return the list of user fields that should be selected to create
5607 * a new user object.
5608 * @deprecated since 1.31, use self::getQueryInfo() instead.
5611 public static function selectFields() {
5612 wfDeprecated( __METHOD__
, '1.31' );
5620 'user_email_authenticated',
5622 'user_email_token_expires',
5623 'user_registration',
5629 * Return the tables, fields, and join conditions to be selected to create
5630 * a new user object.
5632 * @return array With three keys:
5633 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
5634 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
5635 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
5637 public static function getQueryInfo() {
5638 global $wgActorTableSchemaMigrationStage;
5641 'tables' => [ 'user' ],
5649 'user_email_authenticated',
5651 'user_email_token_expires',
5652 'user_registration',
5658 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
5659 // but it does little harm and might be needed for write callers loading a User.
5660 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
5661 $ret['tables']['user_actor'] = 'actor';
5662 $ret['fields'][] = 'user_actor.actor_id';
5663 $ret['joins']['user_actor'] = [
5664 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) ?
'JOIN' : 'LEFT JOIN',
5665 [ 'user_actor.actor_user = user_id' ]
5673 * Factory function for fatal permission-denied errors
5676 * @param string $permission User right required
5679 static function newFatalPermissionDeniedStatus( $permission ) {
5683 foreach ( self
::getGroupsWithPermission( $permission ) as $group ) {
5684 $groups[] = UserGroupMembership
::getLink( $group, RequestContext
::getMain(), 'wiki' );
5688 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5691 return Status
::newFatal( 'badaccess-group0' );
5695 * Get a new instance of this user that was loaded from the master via a locking read
5697 * Use this instead of the main context User when updating that user. This avoids races
5698 * where that user was loaded from a replica DB or even the master but without proper locks.
5700 * @return User|null Returns null if the user was not found in the DB
5703 public function getInstanceForUpdate() {
5704 if ( !$this->getId() ) {
5705 return null; // anon
5708 $user = self
::newFromId( $this->getId() );
5709 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5717 * Checks if two user objects point to the same user.
5719 * @since 1.25 ; takes a UserIdentity instead of a User since 1.32
5720 * @param UserIdentity $user
5723 public function equals( UserIdentity
$user ) {
5724 // XXX it's not clear whether central ID providers are supposed to obey this
5725 return $this->getName() === $user->getName();
5729 * Checks if usertalk is allowed
5733 public function isAllowUsertalk() {
5734 return $this->mAllowUsertalk
;