3 * Implements the User class for the %MediaWiki software.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\MediaWikiServices
;
24 use MediaWiki\Session\SessionManager
;
25 use MediaWiki\Session\Token
;
26 use MediaWiki\Auth\AuthManager
;
27 use MediaWiki\Auth\AuthenticationResponse
;
28 use MediaWiki\Auth\AuthenticationRequest
;
29 use MediaWiki\User\UserIdentity
;
30 use MediaWiki\Logger\LoggerFactory
;
32 use Wikimedia\ScopedCallback
;
33 use Wikimedia\Rdbms\Database
;
34 use Wikimedia\Rdbms\DBExpectedError
;
35 use Wikimedia\Rdbms\IDatabase
;
38 * The User object encapsulates all of the user-specific settings (user_id,
39 * name, rights, email address, options, last login time). Client
40 * classes use the getXXX() functions to access these fields. These functions
41 * do all the work of determining whether the user is logged in,
42 * whether the requested option can be satisfied from cookies or
43 * whether a database query is needed. Most of the settings needed
44 * for rendering normal pages are set in the cookie to minimize use
47 class User
implements IDBAccessObject
, UserIdentity
{
49 * @const int Number of characters in user_token field.
51 const TOKEN_LENGTH
= 32;
54 * @const string An invalid value for user_token
56 const INVALID_TOKEN
= '*** INVALID ***';
59 * @const int Serialized record version.
64 * Exclude user options that are set to their default value.
67 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
72 const CHECK_USER_RIGHTS
= true;
77 const IGNORE_USER_RIGHTS
= false;
80 * Array of Strings List of member variables which are saved to the
81 * shared cache (memcached). Any operation which changes the
82 * corresponding database fields must call a cache-clearing function.
85 protected static $mCacheVars = [
93 'mEmailAuthenticated',
100 // user_properties table
107 * Array of Strings Core rights.
108 * Each of these should have a corresponding message of the form
112 protected static $mCoreRights = [
160 'move-categorypages',
161 'move-rootuserpages',
165 'override-export-depth',
187 'userrights-interwiki',
195 * String Cached results of getAllRights()
197 protected static $mAllRights = false;
199 /** Cache variables */
212 /** @var string TS_MW timestamp from the DB */
214 /** @var string TS_MW timestamp from cache */
215 protected $mQuickTouched;
219 public $mEmailAuthenticated;
221 protected $mEmailToken;
223 protected $mEmailTokenExpires;
225 protected $mRegistration;
227 protected $mEditCount;
228 /** @var UserGroupMembership[] Associative array of (group name => UserGroupMembership object) */
229 protected $mGroupMemberships;
231 protected $mOptionOverrides;
235 * Bool Whether the cache variables have been loaded.
238 public $mOptionsLoaded;
241 * Array with already loaded items or true if all items have been loaded.
243 protected $mLoadedItems = [];
247 * String Initialization data source if mLoadedItems!==true. May be one of:
248 * - 'defaults' anonymous user initialised from class defaults
249 * - 'name' initialise from mName
250 * - 'id' initialise from mId
251 * - 'actor' initialise from mActorId
252 * - 'session' log in from session if possible
254 * Use the User::newFrom*() family of functions to set this.
259 * Lazy-initialized variables, invalidated with clearInstanceCache
263 protected $mDatePreference;
271 protected $mBlockreason;
273 protected $mEffectiveGroups;
275 protected $mImplicitGroups;
277 protected $mFormerGroups;
279 protected $mGlobalBlock;
287 /** @var WebRequest */
294 protected $mAllowUsertalk;
297 private $mBlockedFromCreateAccount = false;
299 /** @var int User::READ_* constant bitfield used to load data */
300 protected $queryFlagsUsed = self
::READ_NORMAL
;
302 public static $idCacheByName = [];
305 * Lightweight constructor for an anonymous user.
306 * Use the User::newFrom* factory functions for other kinds of users.
310 * @see newFromActorId()
311 * @see newFromConfirmationCode()
312 * @see newFromSession()
315 public function __construct() {
316 $this->clearInstanceCache( 'defaults' );
322 public function __toString() {
323 return (string)$this->getName();
327 * Test if it's safe to load this User object.
329 * You should typically check this before using $wgUser or
330 * RequestContext::getUser in a method that might be called before the
331 * system has been fully initialized. If the object is unsafe, you should
332 * use an anonymous user:
334 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
340 public function isSafeToLoad() {
341 global $wgFullyInitialised;
343 // The user is safe to load if:
344 // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
345 // * mLoadedItems === true (already loaded)
346 // * mFrom !== 'session' (sessions not involved at all)
348 return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
349 $this->mLoadedItems
=== true ||
$this->mFrom
!== 'session';
353 * Load the user table data for this object from the source given by mFrom.
355 * @param int $flags User::READ_* constant bitfield
357 public function load( $flags = self
::READ_NORMAL
) {
358 global $wgFullyInitialised;
360 if ( $this->mLoadedItems
=== true ) {
364 // Set it now to avoid infinite recursion in accessors
365 $oldLoadedItems = $this->mLoadedItems
;
366 $this->mLoadedItems
= true;
367 $this->queryFlagsUsed
= $flags;
369 // If this is called too early, things are likely to break.
370 if ( !$wgFullyInitialised && $this->mFrom
=== 'session' ) {
371 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
372 ->warning( 'User::loadFromSession called before the end of Setup.php', [
373 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
375 $this->loadDefaults();
376 $this->mLoadedItems
= $oldLoadedItems;
380 switch ( $this->mFrom
) {
382 $this->loadDefaults();
385 // Make sure this thread sees its own changes
386 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
387 if ( $lb->hasOrMadeRecentMasterChanges() ) {
388 $flags |
= self
::READ_LATEST
;
389 $this->queryFlagsUsed
= $flags;
392 $this->mId
= self
::idFromName( $this->mName
, $flags );
394 // Nonexistent user placeholder object
395 $this->loadDefaults( $this->mName
);
397 $this->loadFromId( $flags );
401 // Make sure this thread sees its own changes, if the ID isn't 0
402 if ( $this->mId
!= 0 ) {
403 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
404 if ( $lb->hasOrMadeRecentMasterChanges() ) {
405 $flags |
= self
::READ_LATEST
;
406 $this->queryFlagsUsed
= $flags;
410 $this->loadFromId( $flags );
413 // Make sure this thread sees its own changes
414 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
415 if ( $lb->hasOrMadeRecentMasterChanges() ) {
416 $flags |
= self
::READ_LATEST
;
417 $this->queryFlagsUsed
= $flags;
420 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
421 $row = wfGetDB( $index )->selectRow(
423 [ 'actor_user', 'actor_name' ],
424 [ 'actor_id' => $this->mActorId
],
431 $this->loadDefaults();
432 } elseif ( $row->actor_user
) {
433 $this->mId
= $row->actor_user
;
434 $this->loadFromId( $flags );
436 $this->loadDefaults( $row->actor_name
);
440 if ( !$this->loadFromSession() ) {
441 // Loading from session failed. Load defaults.
442 $this->loadDefaults();
444 Hooks
::run( 'UserLoadAfterLoadFromSession', [ $this ] );
447 throw new UnexpectedValueException(
448 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
453 * Load user table data, given mId has already been set.
454 * @param int $flags User::READ_* constant bitfield
455 * @return bool False if the ID does not exist, true otherwise
457 public function loadFromId( $flags = self
::READ_NORMAL
) {
458 if ( $this->mId
== 0 ) {
459 // Anonymous users are not in the database (don't need cache)
460 $this->loadDefaults();
464 // Try cache (unless this needs data from the master DB).
465 // NOTE: if this thread called saveSettings(), the cache was cleared.
466 $latest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
468 if ( !$this->loadFromDatabase( $flags ) ) {
469 // Can't load from ID
473 $this->loadFromCache();
476 $this->mLoadedItems
= true;
477 $this->queryFlagsUsed
= $flags;
484 * @param string $wikiId
487 public static function purge( $wikiId, $userId ) {
488 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
489 $key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
490 $cache->delete( $key );
495 * @param WANObjectCache $cache
498 protected function getCacheKey( WANObjectCache
$cache ) {
499 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
501 return $cache->makeGlobalKey( 'user', 'id', $lbFactory->getLocalDomainID(), $this->mId
);
505 * @param WANObjectCache $cache
509 public function getMutableCacheKeys( WANObjectCache
$cache ) {
510 $id = $this->getId();
512 return $id ?
[ $this->getCacheKey( $cache ) ] : [];
516 * Load user data from shared cache, given mId has already been set.
521 protected function loadFromCache() {
522 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
523 $data = $cache->getWithSetCallback(
524 $this->getCacheKey( $cache ),
526 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
527 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
528 wfDebug( "User: cache miss for user {$this->mId}\n" );
530 $this->loadFromDatabase( self
::READ_NORMAL
);
532 $this->loadOptions();
535 foreach ( self
::$mCacheVars as $name ) {
536 $data[$name] = $this->$name;
539 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->mTouched
), $ttl );
541 // if a user group membership is about to expire, the cache needs to
542 // expire at that time (T163691)
543 foreach ( $this->mGroupMemberships
as $ugm ) {
544 if ( $ugm->getExpiry() ) {
545 $secondsUntilExpiry = wfTimestamp( TS_UNIX
, $ugm->getExpiry() ) - time();
546 if ( $secondsUntilExpiry > 0 && $secondsUntilExpiry < $ttl ) {
547 $ttl = $secondsUntilExpiry;
554 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'version' => self
::VERSION
]
557 // Restore from cache
558 foreach ( self
::$mCacheVars as $name ) {
559 $this->$name = $data[$name];
565 /** @name newFrom*() static factory methods */
569 * Static factory method for creation from username.
571 * This is slightly less efficient than newFromId(), so use newFromId() if
572 * you have both an ID and a name handy.
574 * @param string $name Username, validated by Title::newFromText()
575 * @param string|bool $validate Validate username. Takes the same parameters as
576 * User::getCanonicalName(), except that true is accepted as an alias
577 * for 'valid', for BC.
579 * @return User|bool User object, or false if the username is invalid
580 * (e.g. if it contains illegal characters or is an IP address). If the
581 * username is not present in the database, the result will be a user object
582 * with a name, zero user ID and default settings.
584 public static function newFromName( $name, $validate = 'valid' ) {
585 if ( $validate === true ) {
588 $name = self
::getCanonicalName( $name, $validate );
589 if ( $name === false ) {
593 // Create unloaded user object
597 $u->setItemLoaded( 'name' );
603 * Static factory method for creation from a given user ID.
605 * @param int $id Valid user ID
606 * @return User The corresponding User object
608 public static function newFromId( $id ) {
612 $u->setItemLoaded( 'id' );
617 * Static factory method for creation from a given actor ID.
620 * @param int $id Valid actor ID
621 * @return User The corresponding User object
623 public static function newFromActorId( $id ) {
624 global $wgActorTableSchemaMigrationStage;
626 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
627 // but it does little harm and might be needed for write callers loading a User.
628 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) ) {
629 throw new BadMethodCallException(
630 'Cannot use ' . __METHOD__
631 . ' when $wgActorTableSchemaMigrationStage lacks SCHEMA_COMPAT_NEW'
638 $u->setItemLoaded( 'actor' );
643 * Returns a User object corresponding to the given UserIdentity.
647 * @param UserIdentity $identity
651 public static function newFromIdentity( UserIdentity
$identity ) {
652 if ( $identity instanceof User
) {
656 return self
::newFromAnyId(
657 $identity->getId() === 0 ?
null : $identity->getId(),
658 $identity->getName() === '' ?
null : $identity->getName(),
659 $identity->getActorId() === 0 ?
null : $identity->getActorId()
664 * Static factory method for creation from an ID, name, and/or actor ID
666 * This does not check that the ID, name, and actor ID all correspond to
670 * @param int|null $userId User ID, if known
671 * @param string|null $userName User name, if known
672 * @param int|null $actorId Actor ID, if known
675 public static function newFromAnyId( $userId, $userName, $actorId ) {
676 global $wgActorTableSchemaMigrationStage;
679 $user->mFrom
= 'defaults';
681 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
682 // but it does little harm and might be needed for write callers loading a User.
683 if ( ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) && $actorId !== null ) {
684 $user->mActorId
= (int)$actorId;
685 if ( $user->mActorId
!== 0 ) {
686 $user->mFrom
= 'actor';
688 $user->setItemLoaded( 'actor' );
691 if ( $userName !== null && $userName !== '' ) {
692 $user->mName
= $userName;
693 $user->mFrom
= 'name';
694 $user->setItemLoaded( 'name' );
697 if ( $userId !== null ) {
698 $user->mId
= (int)$userId;
699 if ( $user->mId
!== 0 ) {
702 $user->setItemLoaded( 'id' );
705 if ( $user->mFrom
=== 'defaults' ) {
706 throw new InvalidArgumentException(
707 'Cannot create a user with no name, no ID, and no actor ID'
715 * Factory method to fetch whichever user has a given email confirmation code.
716 * This code is generated when an account is created or its e-mail address
719 * If the code is invalid or has expired, returns NULL.
721 * @param string $code Confirmation code
722 * @param int $flags User::READ_* bitfield
725 public static function newFromConfirmationCode( $code, $flags = 0 ) {
726 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
727 ?
wfGetDB( DB_MASTER
)
728 : wfGetDB( DB_REPLICA
);
730 $id = $db->selectField(
734 'user_email_token' => md5( $code ),
735 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
739 return $id ? self
::newFromId( $id ) : null;
743 * Create a new user object using data from session. If the login
744 * credentials are invalid, the result is an anonymous user.
746 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
749 public static function newFromSession( WebRequest
$request = null ) {
751 $user->mFrom
= 'session';
752 $user->mRequest
= $request;
757 * Create a new user object from a user row.
758 * The row should have the following fields from the user table in it:
759 * - either user_name or user_id to load further data if needed (or both)
761 * - all other fields (email, etc.)
762 * It is useless to provide the remaining fields if either user_id,
763 * user_name and user_real_name are not provided because the whole row
764 * will be loaded once more from the database when accessing them.
766 * @param stdClass $row A row from the user table
767 * @param array|null $data Further data to load into the object
768 * (see User::loadFromRow for valid keys)
771 public static function newFromRow( $row, $data = null ) {
773 $user->loadFromRow( $row, $data );
778 * Static factory method for creation of a "system" user from username.
780 * A "system" user is an account that's used to attribute logged actions
781 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
782 * might include the 'Maintenance script' or 'Conversion script' accounts
783 * used by various scripts in the maintenance/ directory or accounts such
784 * as 'MediaWiki message delivery' used by the MassMessage extension.
786 * This can optionally create the user if it doesn't exist, and "steal" the
787 * account if it does exist.
789 * "Stealing" an existing user is intended to make it impossible for normal
790 * authentication processes to use the account, effectively disabling the
791 * account for normal use:
792 * - Email is invalidated, to prevent account recovery by emailing a
793 * temporary password and to disassociate the account from the existing
795 * - The token is set to a magic invalid value, to kill existing sessions
796 * and to prevent $this->setToken() calls from resetting the token to a
798 * - SessionManager is instructed to prevent new sessions for the user, to
799 * do things like deauthorizing OAuth consumers.
800 * - AuthManager is instructed to revoke access, to invalidate or remove
801 * passwords and other credentials.
803 * @param string $name Username
804 * @param array $options Options are:
805 * - validate: As for User::getCanonicalName(), default 'valid'
806 * - create: Whether to create the user if it doesn't already exist, default true
807 * - steal: Whether to "disable" the account for normal use if it already
808 * exists, default false
812 public static function newSystemUser( $name, $options = [] ) {
814 'validate' => 'valid',
819 $name = self
::getCanonicalName( $name, $options['validate'] );
820 if ( $name === false ) {
824 $dbr = wfGetDB( DB_REPLICA
);
825 $userQuery = self
::getQueryInfo();
826 $row = $dbr->selectRow(
827 $userQuery['tables'],
828 $userQuery['fields'],
829 [ 'user_name' => $name ],
835 // Try the master database...
836 $dbw = wfGetDB( DB_MASTER
);
837 $row = $dbw->selectRow(
838 $userQuery['tables'],
839 $userQuery['fields'],
840 [ 'user_name' => $name ],
848 // No user. Create it?
849 return $options['create']
850 ? self
::createNew( $name, [ 'token' => self
::INVALID_TOKEN
] )
854 $user = self
::newFromRow( $row );
856 // A user is considered to exist as a non-system user if it can
857 // authenticate, or has an email set, or has a non-invalid token.
858 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
859 AuthManager
::singleton()->userCanAuthenticate( $name )
861 // User exists. Steal it?
862 if ( !$options['steal'] ) {
866 AuthManager
::singleton()->revokeAccessForUser( $name );
868 $user->invalidateEmail();
869 $user->mToken
= self
::INVALID_TOKEN
;
870 $user->saveSettings();
871 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
880 * Get the username corresponding to a given user ID
881 * @param int $id User ID
882 * @return string|bool The corresponding username
884 public static function whoIs( $id ) {
885 return UserCache
::singleton()->getProp( $id, 'name' );
889 * Get the real name of a user given their user ID
891 * @param int $id User ID
892 * @return string|bool The corresponding user's real name
894 public static function whoIsReal( $id ) {
895 return UserCache
::singleton()->getProp( $id, 'real_name' );
899 * Get database id given a user name
900 * @param string $name Username
901 * @param int $flags User::READ_* constant bitfield
902 * @return int|null The corresponding user's ID, or null if user is nonexistent
904 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
905 // Don't explode on self::$idCacheByName[$name] if $name is not a string but e.g. a User object
906 $name = (string)$name;
907 $nt = Title
::makeTitleSafe( NS_USER
, $name );
908 if ( is_null( $nt ) ) {
913 if ( !( $flags & self
::READ_LATEST
) && array_key_exists( $name, self
::$idCacheByName ) ) {
914 return self
::$idCacheByName[$name];
917 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
918 $db = wfGetDB( $index );
923 [ 'user_name' => $nt->getText() ],
928 if ( $s === false ) {
931 $result = (int)$s->user_id
;
934 self
::$idCacheByName[$name] = $result;
936 if ( count( self
::$idCacheByName ) > 1000 ) {
937 self
::$idCacheByName = [];
944 * Reset the cache used in idFromName(). For use in tests.
946 public static function resetIdByNameCache() {
947 self
::$idCacheByName = [];
951 * Does the string match an anonymous IP address?
953 * This function exists for username validation, in order to reject
954 * usernames which are similar in form to IP addresses. Strings such
955 * as 300.300.300.300 will return true because it looks like an IP
956 * address, despite not being strictly valid.
958 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
959 * address because the usemod software would "cloak" anonymous IP
960 * addresses like this, if we allowed accounts like this to be created
961 * new users could get the old edits of these anonymous users.
963 * @param string $name Name to match
966 public static function isIP( $name ) {
967 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
968 || IP
::isIPv6( $name );
972 * Is the user an IP range?
977 public function isIPRange() {
978 return IP
::isValidRange( $this->mName
);
982 * Is the input a valid username?
984 * Checks if the input is a valid username, we don't want an empty string,
985 * an IP address, anything that contains slashes (would mess up subpages),
986 * is longer than the maximum allowed username size or doesn't begin with
989 * @param string $name Name to match
992 public static function isValidUserName( $name ) {
993 global $wgMaxNameChars;
996 || self
::isIP( $name )
997 ||
strpos( $name, '/' ) !== false
998 ||
strlen( $name ) > $wgMaxNameChars
999 ||
$name != MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name )
1004 // Ensure that the name can't be misresolved as a different title,
1005 // such as with extra namespace keys at the start.
1006 $parsed = Title
::newFromText( $name );
1007 if ( is_null( $parsed )
1008 ||
$parsed->getNamespace()
1009 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
1013 // Check an additional blacklist of troublemaker characters.
1014 // Should these be merged into the title char list?
1015 $unicodeBlacklist = '/[' .
1016 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
1017 '\x{00a0}' . # non-breaking space
1018 '\x{2000}-\x{200f}' . # various whitespace
1019 '\x{2028}-\x{202f}' . # breaks and control chars
1020 '\x{3000}' . # ideographic space
1021 '\x{e000}-\x{f8ff}' . # private use
1023 if ( preg_match( $unicodeBlacklist, $name ) ) {
1031 * Usernames which fail to pass this function will be blocked
1032 * from user login and new account registrations, but may be used
1033 * internally by batch processes.
1035 * If an account already exists in this form, login will be blocked
1036 * by a failure to pass this function.
1038 * @param string $name Name to match
1041 public static function isUsableName( $name ) {
1042 global $wgReservedUsernames;
1043 // Must be a valid username, obviously ;)
1044 if ( !self
::isValidUserName( $name ) ) {
1048 static $reservedUsernames = false;
1049 if ( !$reservedUsernames ) {
1050 $reservedUsernames = $wgReservedUsernames;
1051 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
1054 // Certain names may be reserved for batch processes.
1055 foreach ( $reservedUsernames as $reserved ) {
1056 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
1057 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->plain();
1059 if ( $reserved == $name ) {
1067 * Return the users who are members of the given group(s). In case of multiple groups,
1068 * users who are members of at least one of them are returned.
1070 * @param string|array $groups A single group name or an array of group names
1071 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
1072 * records; larger values are ignored.
1073 * @param int|null $after ID the user to start after
1074 * @return UserArrayFromResult
1076 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
1077 if ( $groups === [] ) {
1078 return UserArrayFromResult
::newFromIDs( [] );
1081 $groups = array_unique( (array)$groups );
1082 $limit = min( 5000, $limit );
1084 $conds = [ 'ug_group' => $groups ];
1085 if ( $after !== null ) {
1086 $conds[] = 'ug_user > ' . (int)$after;
1089 $dbr = wfGetDB( DB_REPLICA
);
1090 $ids = $dbr->selectFieldValues(
1097 'ORDER BY' => 'ug_user',
1101 return UserArray
::newFromIDs( $ids );
1105 * Usernames which fail to pass this function will be blocked
1106 * from new account registrations, but may be used internally
1107 * either by batch processes or by user accounts which have
1108 * already been created.
1110 * Additional blacklisting may be added here rather than in
1111 * isValidUserName() to avoid disrupting existing accounts.
1113 * @param string $name String to match
1116 public static function isCreatableName( $name ) {
1117 global $wgInvalidUsernameCharacters;
1119 // Ensure that the username isn't longer than 235 bytes, so that
1120 // (at least for the builtin skins) user javascript and css files
1121 // will work. (T25080)
1122 if ( strlen( $name ) > 235 ) {
1123 wfDebugLog( 'username', __METHOD__
.
1124 ": '$name' invalid due to length" );
1128 // Preg yells if you try to give it an empty string
1129 if ( $wgInvalidUsernameCharacters !== '' &&
1130 preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name )
1132 wfDebugLog( 'username', __METHOD__
.
1133 ": '$name' invalid due to wgInvalidUsernameCharacters" );
1137 return self
::isUsableName( $name );
1141 * Is the input a valid password for this user?
1143 * @param string $password Desired password
1146 public function isValidPassword( $password ) {
1147 // simple boolean wrapper for checkPasswordValidity
1148 return $this->checkPasswordValidity( $password )->isGood();
1152 * Given unvalidated password input, return error message on failure.
1154 * @param string $password Desired password
1155 * @return bool|string|array True on success, string or array of error message on failure
1156 * @deprecated since 1.33, use checkPasswordValidity
1158 public function getPasswordValidity( $password ) {
1159 wfDeprecated( __METHOD__
, '1.33' );
1161 $result = $this->checkPasswordValidity( $password );
1162 if ( $result->isGood() ) {
1167 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
1168 $messages[] = $error['message'];
1170 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
1171 $messages[] = $warning['message'];
1173 if ( count( $messages ) === 1 ) {
1174 return $messages[0];
1181 * Check if this is a valid password for this user
1183 * Returns a Status object with a set of messages describing
1184 * problems with the password. If the return status is fatal,
1185 * the action should be refused and the password should not be
1186 * checked at all (this is mainly meant for DoS mitigation).
1187 * If the return value is OK but not good, the password can be checked,
1188 * but the user should not be able to set their password to this.
1189 * The value of the returned Status object will be an array which
1190 * can have the following fields:
1191 * - forceChange (bool): if set to true, the user should not be
1192 * allowed to log with this password unless they change it during
1193 * the login process (see ResetPasswordSecondaryAuthenticationProvider).
1194 * - suggestChangeOnLogin (bool): if set to true, the user should be prompted for
1195 * a password change on login.
1197 * @param string $password Desired password
1201 public function checkPasswordValidity( $password ) {
1202 global $wgPasswordPolicy;
1204 $upp = new UserPasswordPolicy(
1205 $wgPasswordPolicy['policies'],
1206 $wgPasswordPolicy['checks']
1209 $status = Status
::newGood( [] );
1210 $result = false; // init $result to false for the internal checks
1212 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1213 $status->error( $result );
1217 if ( $result === false ) {
1218 $status->merge( $upp->checkUserPassword( $this, $password ), true );
1222 if ( $result === true ) {
1226 $status->error( $result );
1227 return $status; // the isValidPassword hook set a string $result and returned true
1231 * Given unvalidated user input, return a canonical username, or false if
1232 * the username is invalid.
1233 * @param string $name User input
1234 * @param string|bool $validate Type of validation to use:
1235 * - false No validation
1236 * - 'valid' Valid for batch processes
1237 * - 'usable' Valid for batch processes and login
1238 * - 'creatable' Valid for batch processes, login and account creation
1240 * @throws InvalidArgumentException
1241 * @return bool|string
1243 public static function getCanonicalName( $name, $validate = 'valid' ) {
1244 // Force usernames to capital
1245 $name = MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name );
1247 # Reject names containing '#'; these will be cleaned up
1248 # with title normalisation, but then it's too late to
1250 if ( strpos( $name, '#' ) !== false ) {
1254 // Clean up name according to title rules,
1255 // but only when validation is requested (T14654)
1256 $t = ( $validate !== false ) ?
1257 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1258 // Check for invalid titles
1259 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1263 $name = $t->getText();
1265 switch ( $validate ) {
1269 if ( !self
::isValidUserName( $name ) ) {
1274 if ( !self
::isUsableName( $name ) ) {
1279 if ( !self
::isCreatableName( $name ) ) {
1284 throw new InvalidArgumentException(
1285 'Invalid parameter value for $validate in ' . __METHOD__
);
1291 * Return a random password.
1293 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1294 * @return string New random password
1296 public static function randomPassword() {
1297 global $wgMinimalPasswordLength;
1298 return PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1302 * Set cached properties to default.
1304 * @note This no longer clears uncached lazy-initialised properties;
1305 * the constructor does that instead.
1307 * @param string|bool $name
1309 public function loadDefaults( $name = false ) {
1311 $this->mName
= $name;
1312 $this->mActorId
= null;
1313 $this->mRealName
= '';
1315 $this->mOptionOverrides
= null;
1316 $this->mOptionsLoaded
= false;
1318 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1319 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1320 if ( $loggedOut !== 0 ) {
1321 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1323 $this->mTouched
= '1'; # Allow any pages to be cached
1326 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1327 $this->mEmailAuthenticated
= null;
1328 $this->mEmailToken
= '';
1329 $this->mEmailTokenExpires
= null;
1330 $this->mRegistration
= wfTimestamp( TS_MW
);
1331 $this->mGroupMemberships
= [];
1333 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1337 * Return whether an item has been loaded.
1339 * @param string $item Item to check. Current possibilities:
1343 * @param string $all 'all' to check if the whole object has been loaded
1344 * or any other string to check if only the item is available (e.g.
1348 public function isItemLoaded( $item, $all = 'all' ) {
1349 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1350 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1354 * Set that an item has been loaded
1356 * @param string $item
1358 protected function setItemLoaded( $item ) {
1359 if ( is_array( $this->mLoadedItems
) ) {
1360 $this->mLoadedItems
[$item] = true;
1365 * Load user data from the session.
1367 * @return bool True if the user is logged in, false otherwise.
1369 private function loadFromSession() {
1372 Hooks
::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1373 if ( $result !== null ) {
1377 // MediaWiki\Session\Session already did the necessary authentication of the user
1378 // returned here, so just use it if applicable.
1379 $session = $this->getRequest()->getSession();
1380 $user = $session->getUser();
1381 if ( $user->isLoggedIn() ) {
1382 $this->loadFromUserObject( $user );
1383 if ( $user->isBlocked() ) {
1384 // If this user is autoblocked, set a cookie to track the Block. This has to be done on
1385 // every session load, because an autoblocked editor might not edit again from the same
1386 // IP address after being blocked.
1387 $this->trackBlockWithCookie();
1390 // Other code expects these to be set in the session, so set them.
1391 $session->set( 'wsUserID', $this->getId() );
1392 $session->set( 'wsUserName', $this->getName() );
1393 $session->set( 'wsToken', $this->getToken() );
1402 * Set the 'BlockID' cookie depending on block type and user authentication status.
1404 public function trackBlockWithCookie() {
1405 $block = $this->getBlock();
1406 if ( $block && $this->getRequest()->getCookie( 'BlockID' ) === null ) {
1407 $config = RequestContext
::getMain()->getConfig();
1408 $shouldSetCookie = false;
1410 if ( $this->isAnon() && $config->get( 'CookieSetOnIpBlock' ) ) {
1411 // If user is logged-out, set a cookie to track the Block
1412 $shouldSetCookie = in_array( $block->getType(), [
1413 Block
::TYPE_IP
, Block
::TYPE_RANGE
1415 if ( $shouldSetCookie ) {
1416 $block->setCookie( $this->getRequest()->response() );
1418 // temporary measure the use of cookies on ip blocks
1419 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1420 $stats->increment( 'block.ipblock.setCookie.success' );
1422 } elseif ( $this->isLoggedIn() && $config->get( 'CookieSetOnAutoblock' ) ) {
1423 $shouldSetCookie = $block->getType() === Block
::TYPE_USER
&& $block->isAutoblocking();
1424 if ( $shouldSetCookie ) {
1425 $block->setCookie( $this->getRequest()->response() );
1432 * Load user and user_group data from the database.
1433 * $this->mId must be set, this is how the user is identified.
1435 * @param int $flags User::READ_* constant bitfield
1436 * @return bool True if the user exists, false if the user is anonymous
1438 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1440 $this->mId
= intval( $this->mId
);
1442 if ( !$this->mId
) {
1443 // Anonymous users are not in the database
1444 $this->loadDefaults();
1448 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1449 $db = wfGetDB( $index );
1451 $userQuery = self
::getQueryInfo();
1452 $s = $db->selectRow(
1453 $userQuery['tables'],
1454 $userQuery['fields'],
1455 [ 'user_id' => $this->mId
],
1461 $this->queryFlagsUsed
= $flags;
1462 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1464 if ( $s !== false ) {
1465 // Initialise user table data
1466 $this->loadFromRow( $s );
1467 $this->mGroupMemberships
= null; // deferred
1468 $this->getEditCount(); // revalidation for nulls
1474 $this->loadDefaults();
1480 * Initialize this object from a row from the user table.
1482 * @param stdClass $row Row from the user table to load.
1483 * @param array|null $data Further user data to load into the object
1485 * user_groups Array of arrays or stdClass result rows out of the user_groups
1486 * table. Previously you were supposed to pass an array of strings
1487 * here, but we also need expiry info nowadays, so an array of
1488 * strings is ignored.
1489 * user_properties Array with properties out of the user_properties table
1491 protected function loadFromRow( $row, $data = null ) {
1492 global $wgActorTableSchemaMigrationStage;
1494 if ( !is_object( $row ) ) {
1495 throw new InvalidArgumentException( '$row must be an object' );
1500 $this->mGroupMemberships
= null; // deferred
1502 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
1503 // but it does little harm and might be needed for write callers loading a User.
1504 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
1505 if ( isset( $row->actor_id
) ) {
1506 $this->mActorId
= (int)$row->actor_id
;
1507 if ( $this->mActorId
!== 0 ) {
1508 $this->mFrom
= 'actor';
1510 $this->setItemLoaded( 'actor' );
1516 if ( isset( $row->user_name
) && $row->user_name
!== '' ) {
1517 $this->mName
= $row->user_name
;
1518 $this->mFrom
= 'name';
1519 $this->setItemLoaded( 'name' );
1524 if ( isset( $row->user_real_name
) ) {
1525 $this->mRealName
= $row->user_real_name
;
1526 $this->setItemLoaded( 'realname' );
1531 if ( isset( $row->user_id
) ) {
1532 $this->mId
= intval( $row->user_id
);
1533 if ( $this->mId
!== 0 ) {
1534 $this->mFrom
= 'id';
1536 $this->setItemLoaded( 'id' );
1541 if ( isset( $row->user_id
) && isset( $row->user_name
) && $row->user_name
!== '' ) {
1542 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1545 if ( isset( $row->user_editcount
) ) {
1546 $this->mEditCount
= $row->user_editcount
;
1551 if ( isset( $row->user_touched
) ) {
1552 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1557 if ( isset( $row->user_token
) ) {
1558 // The definition for the column is binary(32), so trim the NULs
1559 // that appends. The previous definition was char(32), so trim
1561 $this->mToken
= rtrim( $row->user_token
, " \0" );
1562 if ( $this->mToken
=== '' ) {
1563 $this->mToken
= null;
1569 if ( isset( $row->user_email
) ) {
1570 $this->mEmail
= $row->user_email
;
1571 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1572 $this->mEmailToken
= $row->user_email_token
;
1573 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1574 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1580 $this->mLoadedItems
= true;
1583 if ( is_array( $data ) ) {
1584 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1585 if ( $data['user_groups'] === [] ) {
1586 $this->mGroupMemberships
= [];
1588 $firstGroup = reset( $data['user_groups'] );
1589 if ( is_array( $firstGroup ) ||
is_object( $firstGroup ) ) {
1590 $this->mGroupMemberships
= [];
1591 foreach ( $data['user_groups'] as $row ) {
1592 $ugm = UserGroupMembership
::newFromRow( (object)$row );
1593 $this->mGroupMemberships
[$ugm->getGroup()] = $ugm;
1598 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1599 $this->loadOptions( $data['user_properties'] );
1605 * Load the data for this user object from another user object.
1609 protected function loadFromUserObject( $user ) {
1611 foreach ( self
::$mCacheVars as $var ) {
1612 $this->$var = $user->$var;
1617 * Load the groups from the database if they aren't already loaded.
1619 private function loadGroups() {
1620 if ( is_null( $this->mGroupMemberships
) ) {
1621 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1622 ?
wfGetDB( DB_MASTER
)
1623 : wfGetDB( DB_REPLICA
);
1624 $this->mGroupMemberships
= UserGroupMembership
::getMembershipsForUser(
1630 * Add the user to the group if he/she meets given criteria.
1632 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1633 * possible to remove manually via Special:UserRights. In such case it
1634 * will not be re-added automatically. The user will also not lose the
1635 * group if they no longer meet the criteria.
1637 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1639 * @return array Array of groups the user has been promoted to.
1641 * @see $wgAutopromoteOnce
1643 public function addAutopromoteOnceGroups( $event ) {
1644 global $wgAutopromoteOnceLogInRC;
1646 if ( wfReadOnly() ||
!$this->getId() ) {
1650 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1651 if ( $toPromote === [] ) {
1655 if ( !$this->checkAndSetTouched() ) {
1656 return []; // raced out (bug T48834)
1659 $oldGroups = $this->getGroups(); // previous groups
1660 $oldUGMs = $this->getGroupMemberships();
1661 foreach ( $toPromote as $group ) {
1662 $this->addGroup( $group );
1664 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1665 $newUGMs = $this->getGroupMemberships();
1667 // update groups in external authentication database
1668 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );
1670 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1671 $logEntry->setPerformer( $this );
1672 $logEntry->setTarget( $this->getUserPage() );
1673 $logEntry->setParameters( [
1674 '4::oldgroups' => $oldGroups,
1675 '5::newgroups' => $newGroups,
1677 $logid = $logEntry->insert();
1678 if ( $wgAutopromoteOnceLogInRC ) {
1679 $logEntry->publish( $logid );
1686 * Builds update conditions. Additional conditions may be added to $conditions to
1687 * protected against race conditions using a compare-and-set (CAS) mechanism
1688 * based on comparing $this->mTouched with the user_touched field.
1690 * @param Database $db
1691 * @param array $conditions WHERE conditions for use with Database::update
1692 * @return array WHERE conditions for use with Database::update
1694 protected function makeUpdateConditions( Database
$db, array $conditions ) {
1695 if ( $this->mTouched
) {
1696 // CAS check: only update if the row wasn't changed sicne it was loaded.
1697 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1704 * Bump user_touched if it didn't change since this object was loaded
1706 * On success, the mTouched field is updated.
1707 * The user serialization cache is always cleared.
1709 * @return bool Whether user_touched was actually updated
1712 protected function checkAndSetTouched() {
1715 if ( !$this->mId
) {
1716 return false; // anon
1719 // Get a new user_touched that is higher than the old one
1720 $newTouched = $this->newTouchedTimestamp();
1722 $dbw = wfGetDB( DB_MASTER
);
1723 $dbw->update( 'user',
1724 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1725 $this->makeUpdateConditions( $dbw, [
1726 'user_id' => $this->mId
,
1730 $success = ( $dbw->affectedRows() > 0 );
1733 $this->mTouched
= $newTouched;
1734 $this->clearSharedCache();
1736 // Clears on failure too since that is desired if the cache is stale
1737 $this->clearSharedCache( 'refresh' );
1744 * Clear various cached data stored in this object. The cache of the user table
1745 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1747 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1748 * given source. May be "name", "id", "actor", "defaults", "session", or false for no reload.
1750 public function clearInstanceCache( $reloadFrom = false ) {
1751 $this->mNewtalk
= -1;
1752 $this->mDatePreference
= null;
1753 $this->mBlockedby
= -1; # Unset
1754 $this->mHash
= false;
1755 $this->mRights
= null;
1756 $this->mEffectiveGroups
= null;
1757 $this->mImplicitGroups
= null;
1758 $this->mGroupMemberships
= null;
1759 $this->mOptions
= null;
1760 $this->mOptionsLoaded
= false;
1761 $this->mEditCount
= null;
1763 if ( $reloadFrom ) {
1764 $this->mLoadedItems
= [];
1765 $this->mFrom
= $reloadFrom;
1770 * Combine the language default options with any site-specific options
1771 * and add the default language variants.
1773 * @return array Array of String options
1775 public static function getDefaultOptions() {
1776 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgDefaultSkin;
1778 static $defOpt = null;
1779 static $defOptLang = null;
1781 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
1782 if ( $defOpt !== null && $defOptLang === $contLang->getCode() ) {
1783 // The content language does not change (and should not change) mid-request, but the
1784 // unit tests change it anyway, and expect this method to return values relevant to the
1785 // current content language.
1789 $defOpt = $wgDefaultUserOptions;
1790 // Default language setting
1791 $defOptLang = $contLang->getCode();
1792 $defOpt['language'] = $defOptLang;
1793 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1794 if ( $langCode === $contLang->getCode() ) {
1795 $defOpt['variant'] = $langCode;
1797 $defOpt["variant-$langCode"] = $langCode;
1801 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1802 // since extensions may change the set of searchable namespaces depending
1803 // on user groups/permissions.
1804 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1805 $defOpt['searchNs' . $nsnum] = (bool)$val;
1807 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1809 Hooks
::run( 'UserGetDefaultOptions', [ &$defOpt ] );
1815 * Get a given default option value.
1817 * @param string $opt Name of option to retrieve
1818 * @return string Default option value
1820 public static function getDefaultOption( $opt ) {
1821 $defOpts = self
::getDefaultOptions();
1822 return $defOpts[$opt] ??
null;
1826 * Get blocking information
1827 * @param bool $bFromReplica Whether to check the replica DB first.
1828 * To improve performance, non-critical checks are done against replica DBs.
1829 * Check when actually saving should be done against master.
1831 private function getBlockedStatus( $bFromReplica = true ) {
1832 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff, $wgSoftBlockRanges;
1834 if ( $this->mBlockedby
!= -1 ) {
1838 wfDebug( __METHOD__
. ": checking...\n" );
1840 // Initialize data...
1841 // Otherwise something ends up stomping on $this->mBlockedby when
1842 // things get lazy-loaded later, causing false positive block hits
1843 // due to -1 !== 0. Probably session-related... Nothing should be
1844 // overwriting mBlockedby, surely?
1847 # We only need to worry about passing the IP address to the Block generator if the
1848 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1849 # know which IP address they're actually coming from
1851 if ( !$this->isAllowed( 'ipblock-exempt' ) ) {
1852 // $wgUser->getName() only works after the end of Setup.php. Until
1853 // then, assume it's a logged-out user.
1854 $globalUserName = $wgUser->isSafeToLoad()
1855 ?
$wgUser->getName()
1856 : IP
::sanitizeIP( $wgUser->getRequest()->getIP() );
1857 if ( $this->getName() === $globalUserName ) {
1858 $ip = $this->getRequest()->getIP();
1863 $block = Block
::newFromTarget( $this, $ip, !$bFromReplica );
1866 if ( !$block instanceof Block
) {
1867 $block = $this->getBlockFromCookieValue( $this->getRequest()->getCookie( 'BlockID' ) );
1871 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1873 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1874 $block = new Block( [
1875 'byText' => wfMessage( 'proxyblocker' )->text(),
1876 'reason' => wfMessage( 'proxyblockreason' )->plain(),
1878 'systemBlock' => 'proxy',
1880 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1881 $block = new Block( [
1882 'byText' => wfMessage( 'sorbs' )->text(),
1883 'reason' => wfMessage( 'sorbsreason' )->plain(),
1885 'systemBlock' => 'dnsbl',
1890 // (T25343) Apply IP blocks to the contents of XFF headers, if enabled
1891 if ( !$block instanceof Block
1892 && $wgApplyIpBlocksToXff
1894 && !in_array( $ip, $wgProxyWhitelist )
1896 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1897 $xff = array_map( 'trim', explode( ',', $xff ) );
1898 $xff = array_diff( $xff, [ $ip ] );
1899 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromReplica );
1900 $block = Block
::chooseBlock( $xffblocks, $xff );
1901 if ( $block instanceof Block
) {
1902 # Mangle the reason to alert the user that the block
1903 # originated from matching the X-Forwarded-For header.
1904 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->plain();
1908 if ( !$block instanceof Block
1911 && IP
::isInRanges( $ip, $wgSoftBlockRanges )
1913 $block = new Block( [
1915 'byText' => 'MediaWiki default',
1916 'reason' => wfMessage( 'softblockrangesreason', $ip )->plain(),
1918 'systemBlock' => 'wgSoftBlockRanges',
1922 if ( $block instanceof Block
) {
1923 wfDebug( __METHOD__
. ": Found block.\n" );
1924 $this->mBlock
= $block;
1925 $this->mBlockedby
= $block->getByName();
1926 $this->mBlockreason
= $block->mReason
;
1927 $this->mHideName
= $block->mHideName
;
1928 $this->mAllowUsertalk
= $block->isUsertalkEditAllowed();
1930 $this->mBlock
= null;
1931 $this->mBlockedby
= '';
1932 $this->mBlockreason
= '';
1933 $this->mHideName
= 0;
1934 $this->mAllowUsertalk
= false;
1937 // Avoid PHP 7.1 warning of passing $this by reference
1940 Hooks
::run( 'GetBlockedStatus', [ &$user ] );
1944 * Try to load a Block from an ID given in a cookie value.
1945 * @param string|null $blockCookieVal The cookie value to check.
1946 * @return Block|bool The Block object, or false if none could be loaded.
1948 protected function getBlockFromCookieValue( $blockCookieVal ) {
1949 // Make sure there's something to check. The cookie value must start with a number.
1950 if ( strlen( $blockCookieVal ) < 1 ||
!is_numeric( substr( $blockCookieVal, 0, 1 ) ) ) {
1953 // Load the Block from the ID in the cookie.
1954 $blockCookieId = Block
::getIdFromCookieValue( $blockCookieVal );
1955 if ( $blockCookieId !== null ) {
1956 // An ID was found in the cookie.
1957 $tmpBlock = Block
::newFromID( $blockCookieId );
1958 if ( $tmpBlock instanceof Block
) {
1959 $config = RequestContext
::getMain()->getConfig();
1961 switch ( $tmpBlock->getType() ) {
1962 case Block
::TYPE_USER
:
1963 $blockIsValid = !$tmpBlock->isExpired() && $tmpBlock->isAutoblocking();
1964 $useBlockCookie = ( $config->get( 'CookieSetOnAutoblock' ) === true );
1966 case Block
::TYPE_IP
:
1967 case Block
::TYPE_RANGE
:
1968 // If block is type IP or IP range, load only if user is not logged in (T152462)
1969 $blockIsValid = !$tmpBlock->isExpired() && !$this->isLoggedIn();
1970 $useBlockCookie = ( $config->get( 'CookieSetOnIpBlock' ) === true );
1973 $blockIsValid = false;
1974 $useBlockCookie = false;
1977 if ( $blockIsValid && $useBlockCookie ) {
1982 // If the block is not valid, remove the cookie.
1983 Block
::clearCookie( $this->getRequest()->response() );
1985 // If the block doesn't exist, remove the cookie.
1986 Block
::clearCookie( $this->getRequest()->response() );
1993 * Whether the given IP is in a DNS blacklist.
1995 * @param string $ip IP to check
1996 * @param bool $checkWhitelist Whether to check the whitelist first
1997 * @return bool True if blacklisted.
1999 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
2000 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
2002 if ( !$wgEnableDnsBlacklist ||
2003 ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
2008 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
2012 * Whether the given IP is in a given DNS blacklist.
2014 * @param string $ip IP to check
2015 * @param string|array $bases Array of Strings: URL of the DNS blacklist
2016 * @return bool True if blacklisted.
2018 public function inDnsBlacklist( $ip, $bases ) {
2020 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
2021 if ( IP
::isIPv4( $ip ) ) {
2022 // Reverse IP, T23255
2023 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
2025 foreach ( (array)$bases as $base ) {
2027 // If we have an access key, use that too (ProjectHoneypot, etc.)
2029 if ( is_array( $base ) ) {
2030 if ( count( $base ) >= 2 ) {
2031 // Access key is 1, base URL is 0
2032 $host = "{$base[1]}.$ipReversed.{$base[0]}";
2034 $host = "$ipReversed.{$base[0]}";
2036 $basename = $base[0];
2038 $host = "$ipReversed.$base";
2042 $ipList = gethostbynamel( $host );
2045 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
2050 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
2058 * Check if an IP address is in the local proxy list
2064 public static function isLocallyBlockedProxy( $ip ) {
2065 global $wgProxyList;
2067 if ( !$wgProxyList ) {
2071 if ( !is_array( $wgProxyList ) ) {
2072 // Load values from the specified file
2073 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
2076 $resultProxyList = [];
2077 $deprecatedIPEntries = [];
2079 // backward compatibility: move all ip addresses in keys to values
2080 foreach ( $wgProxyList as $key => $value ) {
2081 $keyIsIP = IP
::isIPAddress( $key );
2082 $valueIsIP = IP
::isIPAddress( $value );
2083 if ( $keyIsIP && !$valueIsIP ) {
2084 $deprecatedIPEntries[] = $key;
2085 $resultProxyList[] = $key;
2086 } elseif ( $keyIsIP && $valueIsIP ) {
2087 $deprecatedIPEntries[] = $key;
2088 $resultProxyList[] = $key;
2089 $resultProxyList[] = $value;
2091 $resultProxyList[] = $value;
2095 if ( $deprecatedIPEntries ) {
2097 'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
2098 implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
2101 $proxyListIPSet = new IPSet( $resultProxyList );
2102 return $proxyListIPSet->match( $ip );
2106 * Is this user subject to rate limiting?
2108 * @return bool True if rate limited
2110 public function isPingLimitable() {
2111 global $wgRateLimitsExcludedIPs;
2112 if ( IP
::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
2113 // No other good way currently to disable rate limits
2114 // for specific IPs. :P
2115 // But this is a crappy hack and should die.
2118 return !$this->isAllowed( 'noratelimit' );
2122 * Primitive rate limits: enforce maximum actions per time period
2123 * to put a brake on flooding.
2125 * The method generates both a generic profiling point and a per action one
2126 * (suffix being "-$action".
2128 * @note When using a shared cache like memcached, IP-address
2129 * last-hit counters will be shared across wikis.
2131 * @param string $action Action to enforce; 'edit' if unspecified
2132 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
2133 * @return bool True if a rate limiter was tripped
2135 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
2136 // Avoid PHP 7.1 warning of passing $this by reference
2138 // Call the 'PingLimiter' hook
2140 if ( !Hooks
::run( 'PingLimiter', [ &$user, $action, &$result, $incrBy ] ) ) {
2144 global $wgRateLimits;
2145 if ( !isset( $wgRateLimits[$action] ) ) {
2149 $limits = array_merge(
2150 [ '&can-bypass' => true ],
2151 $wgRateLimits[$action]
2154 // Some groups shouldn't trigger the ping limiter, ever
2155 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
2160 $id = $this->getId();
2162 $isNewbie = $this->isNewbie();
2163 $cache = ObjectCache
::getLocalClusterInstance();
2167 if ( isset( $limits['anon'] ) ) {
2168 $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
2170 } elseif ( isset( $limits['user'] ) ) {
2171 // limits for logged-in users
2172 $userLimit = $limits['user'];
2175 // limits for anons and for newbie logged-in users
2178 if ( isset( $limits['ip'] ) ) {
2179 $ip = $this->getRequest()->getIP();
2180 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
2182 // subnet-based limits
2183 if ( isset( $limits['subnet'] ) ) {
2184 $ip = $this->getRequest()->getIP();
2185 $subnet = IP
::getSubnet( $ip );
2186 if ( $subnet !== false ) {
2187 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
2192 // Check for group-specific permissions
2193 // If more than one group applies, use the group with the highest limit ratio (max/period)
2194 foreach ( $this->getGroups() as $group ) {
2195 if ( isset( $limits[$group] ) ) {
2196 if ( $userLimit === false
2197 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
2199 $userLimit = $limits[$group];
2204 // limits for newbie logged-in users (override all the normal user limits)
2205 if ( $id !== 0 && $isNewbie && isset( $limits['newbie'] ) ) {
2206 $userLimit = $limits['newbie'];
2209 // Set the user limit key
2210 if ( $userLimit !== false ) {
2211 list( $max, $period ) = $userLimit;
2212 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
2213 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
2216 // ip-based limits for all ping-limitable users
2217 if ( isset( $limits['ip-all'] ) ) {
2218 $ip = $this->getRequest()->getIP();
2219 // ignore if user limit is more permissive
2220 if ( $isNewbie ||
$userLimit === false
2221 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
2222 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
2226 // subnet-based limits for all ping-limitable users
2227 if ( isset( $limits['subnet-all'] ) ) {
2228 $ip = $this->getRequest()->getIP();
2229 $subnet = IP
::getSubnet( $ip );
2230 if ( $subnet !== false ) {
2231 // ignore if user limit is more permissive
2232 if ( $isNewbie ||
$userLimit === false
2233 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
2234 > $userLimit[0] / $userLimit[1] ) {
2235 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
2241 foreach ( $keys as $key => $limit ) {
2242 list( $max, $period ) = $limit;
2243 $summary = "(limit $max in {$period}s)";
2244 $count = $cache->get( $key );
2247 if ( $count >= $max ) {
2248 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
2249 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
2252 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
2255 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
2256 if ( $incrBy > 0 ) {
2257 $cache->add( $key, 0, intval( $period ) ); // first ping
2260 if ( $incrBy > 0 ) {
2261 $cache->incr( $key, $incrBy );
2269 * Check if user is blocked
2271 * @param bool $bFromReplica Whether to check the replica DB instead of
2272 * the master. Hacked from false due to horrible probs on site.
2273 * @return bool True if blocked, false otherwise
2275 public function isBlocked( $bFromReplica = true ) {
2276 return $this->getBlock( $bFromReplica ) instanceof Block
&&
2277 $this->getBlock()->appliesToRight( 'edit' );
2281 * Get the block affecting the user, or null if the user is not blocked
2283 * @param bool $bFromReplica Whether to check the replica DB instead of the master
2284 * @return Block|null
2286 public function getBlock( $bFromReplica = true ) {
2287 $this->getBlockedStatus( $bFromReplica );
2288 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
2292 * Check if user is blocked from editing a particular article
2294 * @param Title $title Title to check
2295 * @param bool $fromReplica Whether to check the replica DB instead of the master
2298 public function isBlockedFrom( $title, $fromReplica = false ) {
2299 $blocked = $this->isHidden();
2302 $block = $this->getBlock( $fromReplica );
2304 // Special handling for a user's own talk page. The block is not aware
2305 // of the user, so this must be done here.
2306 if ( $title->equals( $this->getTalkPage() ) ) {
2307 $blocked = $block->appliesToUsertalk( $title );
2309 $blocked = $block->appliesToTitle( $title );
2314 // only for the purpose of the hook. We really don't need this here.
2315 $allowUsertalk = $this->mAllowUsertalk
;
2317 Hooks
::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
2323 * If user is blocked, return the name of the user who placed the block
2324 * @return string Name of blocker
2326 public function blockedBy() {
2327 $this->getBlockedStatus();
2328 return $this->mBlockedby
;
2332 * If user is blocked, return the specified reason for the block
2333 * @return string Blocking reason
2335 public function blockedFor() {
2336 $this->getBlockedStatus();
2337 return $this->mBlockreason
;
2341 * If user is blocked, return the ID for the block
2342 * @return int Block ID
2344 public function getBlockId() {
2345 $this->getBlockedStatus();
2346 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2350 * Check if user is blocked on all wikis.
2351 * Do not use for actual edit permission checks!
2352 * This is intended for quick UI checks.
2354 * @param string $ip IP address, uses current client if none given
2355 * @return bool True if blocked, false otherwise
2357 public function isBlockedGlobally( $ip = '' ) {
2358 return $this->getGlobalBlock( $ip ) instanceof Block
;
2362 * Check if user is blocked on all wikis.
2363 * Do not use for actual edit permission checks!
2364 * This is intended for quick UI checks.
2366 * @param string $ip IP address, uses current client if none given
2367 * @return Block|null Block object if blocked, null otherwise
2368 * @throws FatalError
2369 * @throws MWException
2371 public function getGlobalBlock( $ip = '' ) {
2372 if ( $this->mGlobalBlock
!== null ) {
2373 return $this->mGlobalBlock ?
: null;
2375 // User is already an IP?
2376 if ( IP
::isIPAddress( $this->getName() ) ) {
2377 $ip = $this->getName();
2379 $ip = $this->getRequest()->getIP();
2381 // Avoid PHP 7.1 warning of passing $this by reference
2385 Hooks
::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
2387 if ( $blocked && $block === null ) {
2388 // back-compat: UserIsBlockedGlobally didn't have $block param first
2389 $block = new Block( [
2391 'systemBlock' => 'global-block'
2395 $this->mGlobalBlock
= $blocked ?
$block : false;
2396 return $this->mGlobalBlock ?
: null;
2400 * Check if user account is locked
2402 * @return bool True if locked, false otherwise
2404 public function isLocked() {
2405 if ( $this->mLocked
!== null ) {
2406 return $this->mLocked
;
2409 $this->mLocked
= false;
2410 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2411 return $this->mLocked
;
2415 * Check if user account is hidden
2417 * @return bool True if hidden, false otherwise
2419 public function isHidden() {
2420 if ( $this->mHideName
!== null ) {
2421 return (bool)$this->mHideName
;
2423 $this->getBlockedStatus();
2424 if ( !$this->mHideName
) {
2426 $this->mHideName
= false;
2427 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2429 return (bool)$this->mHideName
;
2433 * Get the user's ID.
2434 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2436 public function getId() {
2437 if ( $this->mId
=== null && $this->mName
!== null && self
::isIP( $this->mName
) ) {
2438 // Special case, we know the user is anonymous
2442 if ( !$this->isItemLoaded( 'id' ) ) {
2443 // Don't load if this was initialized from an ID
2447 return (int)$this->mId
;
2451 * Set the user and reload all fields according to a given ID
2452 * @param int $v User ID to reload
2454 public function setId( $v ) {
2456 $this->clearInstanceCache( 'id' );
2460 * Get the user name, or the IP of an anonymous user
2461 * @return string User's name or IP address
2463 public function getName() {
2464 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2465 // Special case optimisation
2466 return $this->mName
;
2470 if ( $this->mName
=== false ) {
2472 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2475 return $this->mName
;
2479 * Set the user name.
2481 * This does not reload fields from the database according to the given
2482 * name. Rather, it is used to create a temporary "nonexistent user" for
2483 * later addition to the database. It can also be used to set the IP
2484 * address for an anonymous user to something other than the current
2487 * @note User::newFromName() has roughly the same function, when the named user
2489 * @param string $str New user name to set
2491 public function setName( $str ) {
2493 $this->mName
= $str;
2497 * Get the user's actor ID.
2499 * @param IDatabase|null $dbw Assign a new actor ID, using this DB handle, if none exists
2500 * @return int The actor's ID, or 0 if no actor ID exists and $dbw was null
2502 public function getActorId( IDatabase
$dbw = null ) {
2503 global $wgActorTableSchemaMigrationStage;
2505 // Technically we should always return 0 without SCHEMA_COMPAT_READ_NEW,
2506 // but it does little harm and might be needed for write callers loading a User.
2507 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) ) {
2511 if ( !$this->isItemLoaded( 'actor' ) ) {
2515 // Currently $this->mActorId might be null if $this was loaded from a
2516 // cache entry that was written when $wgActorTableSchemaMigrationStage
2517 // was SCHEMA_COMPAT_OLD. Once that is no longer a possibility (i.e. when
2518 // User::VERSION is incremented after $wgActorTableSchemaMigrationStage
2519 // has been removed), that condition may be removed.
2520 if ( $this->mActorId
=== null ||
!$this->mActorId
&& $dbw ) {
2522 'actor_user' => $this->getId() ?
: null,
2523 'actor_name' => (string)$this->getName(),
2526 if ( $q['actor_user'] === null && self
::isUsableName( $q['actor_name'] ) ) {
2527 throw new CannotCreateActorException(
2528 'Cannot create an actor for a usable name that is not an existing user'
2531 if ( $q['actor_name'] === '' ) {
2532 throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
2534 $dbw->insert( 'actor', $q, __METHOD__
, [ 'IGNORE' ] );
2535 if ( $dbw->affectedRows() ) {
2536 $this->mActorId
= (int)$dbw->insertId();
2539 // Use LOCK IN SHARE MODE to bypass any MySQL REPEATABLE-READ snapshot.
2540 $this->mActorId
= (int)$dbw->selectField(
2545 [ 'LOCK IN SHARE MODE' ]
2547 if ( !$this->mActorId
) {
2548 throw new CannotCreateActorException(
2549 "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
2553 $this->invalidateCache();
2555 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2556 $db = wfGetDB( $index );
2557 $this->mActorId
= (int)$db->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2559 $this->setItemLoaded( 'actor' );
2562 return (int)$this->mActorId
;
2566 * Get the user's name escaped by underscores.
2567 * @return string Username escaped by underscores.
2569 public function getTitleKey() {
2570 return str_replace( ' ', '_', $this->getName() );
2574 * Check if the user has new messages.
2575 * @return bool True if the user has new messages
2577 public function getNewtalk() {
2580 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2581 if ( $this->mNewtalk
=== -1 ) {
2582 $this->mNewtalk
= false; # reset talk page status
2584 // Check memcached separately for anons, who have no
2585 // entire User object stored in there.
2586 if ( !$this->mId
) {
2587 global $wgDisableAnonTalk;
2588 if ( $wgDisableAnonTalk ) {
2589 // Anon newtalk disabled by configuration.
2590 $this->mNewtalk
= false;
2592 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2595 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2599 return (bool)$this->mNewtalk
;
2603 * Return the data needed to construct links for new talk page message
2604 * alerts. If there are new messages, this will return an associative array
2605 * with the following data:
2606 * wiki: The database name of the wiki
2607 * link: Root-relative link to the user's talk page
2608 * rev: The last talk page revision that the user has seen or null. This
2609 * is useful for building diff links.
2610 * If there are no new messages, it returns an empty array.
2611 * @note This function was designed to accomodate multiple talk pages, but
2612 * currently only returns a single link and revision.
2615 public function getNewMessageLinks() {
2616 // Avoid PHP 7.1 warning of passing $this by reference
2619 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
2623 if ( !$this->getNewtalk() ) {
2626 $utp = $this->getTalkPage();
2627 $dbr = wfGetDB( DB_REPLICA
);
2628 // Get the "last viewed rev" timestamp from the oldest message notification
2629 $timestamp = $dbr->selectField( 'user_newtalk',
2630 'MIN(user_last_timestamp)',
2631 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2633 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2636 'wiki' => WikiMap
::getWikiIdFromDbDomain( WikiMap
::getCurrentWikiDbDomain() ),
2637 'link' => $utp->getLocalURL(),
2644 * Get the revision ID for the last talk page revision viewed by the talk
2646 * @return int|null Revision ID or null
2648 public function getNewMessageRevisionId() {
2649 $newMessageRevisionId = null;
2650 $newMessageLinks = $this->getNewMessageLinks();
2652 // Note: getNewMessageLinks() never returns more than a single link
2653 // and it is always for the same wiki, but we double-check here in
2654 // case that changes some time in the future.
2655 if ( $newMessageLinks && count( $newMessageLinks ) === 1
2656 && WikiMap
::isCurrentWikiId( $newMessageLinks[0]['wiki'] )
2657 && $newMessageLinks[0]['rev']
2659 /** @var Revision $newMessageRevision */
2660 $newMessageRevision = $newMessageLinks[0]['rev'];
2661 $newMessageRevisionId = $newMessageRevision->getId();
2664 return $newMessageRevisionId;
2668 * Internal uncached check for new messages
2671 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2672 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2673 * @return bool True if the user has new messages
2675 protected function checkNewtalk( $field, $id ) {
2676 $dbr = wfGetDB( DB_REPLICA
);
2678 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2680 return $ok !== false;
2684 * Add or update the new messages flag
2685 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2686 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2687 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2688 * @return bool True if successful, false otherwise
2690 protected function updateNewtalk( $field, $id, $curRev = null ) {
2691 // Get timestamp of the talk page revision prior to the current one
2692 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2693 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2694 // Mark the user as having new messages since this revision
2695 $dbw = wfGetDB( DB_MASTER
);
2696 $dbw->insert( 'user_newtalk',
2697 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2700 if ( $dbw->affectedRows() ) {
2701 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2705 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2710 * Clear the new messages flag for the given user
2711 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2712 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2713 * @return bool True if successful, false otherwise
2715 protected function deleteNewtalk( $field, $id ) {
2716 $dbw = wfGetDB( DB_MASTER
);
2717 $dbw->delete( 'user_newtalk',
2720 if ( $dbw->affectedRows() ) {
2721 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2725 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2730 * Update the 'You have new messages!' status.
2731 * @param bool $val Whether the user has new messages
2732 * @param Revision|null $curRev New, as yet unseen revision of the user talk
2733 * page. Ignored if null or !$val.
2735 public function setNewtalk( $val, $curRev = null ) {
2736 if ( wfReadOnly() ) {
2741 $this->mNewtalk
= $val;
2743 if ( $this->isAnon() ) {
2745 $id = $this->getName();
2748 $id = $this->getId();
2752 $changed = $this->updateNewtalk( $field, $id, $curRev );
2754 $changed = $this->deleteNewtalk( $field, $id );
2758 $this->invalidateCache();
2763 * Generate a current or new-future timestamp to be stored in the
2764 * user_touched field when we update things.
2765 * @return string Timestamp in TS_MW format
2767 private function newTouchedTimestamp() {
2768 global $wgClockSkewFudge;
2770 $time = wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2771 if ( $this->mTouched
&& $time <= $this->mTouched
) {
2772 $time = wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2779 * Clear user data from memcached
2781 * Use after applying updates to the database; caller's
2782 * responsibility to update user_touched if appropriate.
2784 * Called implicitly from invalidateCache() and saveSettings().
2786 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2788 public function clearSharedCache( $mode = 'changed' ) {
2789 if ( !$this->getId() ) {
2793 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2794 $key = $this->getCacheKey( $cache );
2795 if ( $mode === 'refresh' ) {
2796 $cache->delete( $key, 1 );
2798 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2799 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2800 $lb->getConnection( DB_MASTER
)->onTransactionPreCommitOrIdle(
2801 function () use ( $cache, $key ) {
2802 $cache->delete( $key );
2807 $cache->delete( $key );
2813 * Immediately touch the user data cache for this account
2815 * Calls touch() and removes account data from memcached
2817 public function invalidateCache() {
2819 $this->clearSharedCache();
2823 * Update the "touched" timestamp for the user
2825 * This is useful on various login/logout events when making sure that
2826 * a browser or proxy that has multiple tenants does not suffer cache
2827 * pollution where the new user sees the old users content. The value
2828 * of getTouched() is checked when determining 304 vs 200 responses.
2829 * Unlike invalidateCache(), this preserves the User object cache and
2830 * avoids database writes.
2834 public function touch() {
2835 $id = $this->getId();
2837 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2838 $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
2839 $cache->touchCheckKey( $key );
2840 $this->mQuickTouched
= null;
2845 * Validate the cache for this account.
2846 * @param string $timestamp A timestamp in TS_MW format
2849 public function validateCache( $timestamp ) {
2850 return ( $timestamp >= $this->getTouched() );
2854 * Get the user touched timestamp
2856 * Use this value only to validate caches via inequalities
2857 * such as in the case of HTTP If-Modified-Since response logic
2859 * @return string TS_MW Timestamp
2861 public function getTouched() {
2865 if ( $this->mQuickTouched
=== null ) {
2866 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2867 $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId
);
2869 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2872 return max( $this->mTouched
, $this->mQuickTouched
);
2875 return $this->mTouched
;
2879 * Get the user_touched timestamp field (time of last DB updates)
2880 * @return string TS_MW Timestamp
2883 public function getDBTouched() {
2886 return $this->mTouched
;
2890 * Set the password and reset the random token.
2891 * Calls through to authentication plugin if necessary;
2892 * will have no effect if the auth plugin refuses to
2893 * pass the change through or if the legal password
2896 * As a special case, setting the password to null
2897 * wipes it, so the account cannot be logged in until
2898 * a new password is set, for instance via e-mail.
2900 * @deprecated since 1.27, use AuthManager instead
2901 * @param string $str New password to set
2902 * @throws PasswordError On failure
2905 public function setPassword( $str ) {
2906 wfDeprecated( __METHOD__
, '1.27' );
2907 return $this->setPasswordInternal( $str );
2911 * Set the password and reset the random token unconditionally.
2913 * @deprecated since 1.27, use AuthManager instead
2914 * @param string|null $str New password to set or null to set an invalid
2915 * password hash meaning that the user will not be able to log in
2916 * through the web interface.
2918 public function setInternalPassword( $str ) {
2919 wfDeprecated( __METHOD__
, '1.27' );
2920 $this->setPasswordInternal( $str );
2924 * Actually set the password and such
2925 * @since 1.27 cannot set a password for a user not in the database
2926 * @param string|null $str New password to set or null to set an invalid
2927 * password hash meaning that the user will not be able to log in
2928 * through the web interface.
2929 * @return bool Success
2931 private function setPasswordInternal( $str ) {
2932 $manager = AuthManager
::singleton();
2934 // If the user doesn't exist yet, fail
2935 if ( !$manager->userExists( $this->getName() ) ) {
2936 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2939 $status = $this->changeAuthenticationData( [
2940 'username' => $this->getName(),
2944 if ( !$status->isGood() ) {
2945 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2946 ->info( __METHOD__
. ': Password change rejected: '
2947 . $status->getWikiText( null, null, 'en' ) );
2951 $this->setOption( 'watchlisttoken', false );
2952 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2958 * Changes credentials of the user.
2960 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2961 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2962 * e.g. when no provider handled the change.
2964 * @param array $data A set of authentication data in fieldname => value format. This is the
2965 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2969 public function changeAuthenticationData( array $data ) {
2970 $manager = AuthManager
::singleton();
2971 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2972 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2974 $status = Status
::newGood( 'ignored' );
2975 foreach ( $reqs as $req ) {
2976 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2978 if ( $status->getValue() === 'ignored' ) {
2979 $status->warning( 'authenticationdatachange-ignored' );
2982 if ( $status->isGood() ) {
2983 foreach ( $reqs as $req ) {
2984 $manager->changeAuthenticationData( $req );
2991 * Get the user's current token.
2992 * @param bool $forceCreation Force the generation of a new token if the
2993 * user doesn't have one (default=true for backwards compatibility).
2994 * @return string|null Token
2996 public function getToken( $forceCreation = true ) {
2997 global $wgAuthenticationTokenVersion;
3000 if ( !$this->mToken
&& $forceCreation ) {
3004 if ( !$this->mToken
) {
3005 // The user doesn't have a token, return null to indicate that.
3009 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
3010 // We return a random value here so existing token checks are very
3012 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3015 if ( $wgAuthenticationTokenVersion === null ) {
3016 // $wgAuthenticationTokenVersion not in use, so return the raw secret
3017 return $this->mToken
;
3020 // $wgAuthenticationTokenVersion in use, so hmac it.
3021 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
3023 // The raw hash can be overly long. Shorten it up.
3024 $len = max( 32, self
::TOKEN_LENGTH
);
3025 if ( strlen( $ret ) < $len ) {
3026 // Should never happen, even md5 is 128 bits
3027 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
3030 return substr( $ret, -$len );
3034 * Set the random token (used for persistent authentication)
3035 * Called from loadDefaults() among other places.
3037 * @param string|bool $token If specified, set the token to this value
3039 public function setToken( $token = false ) {
3041 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
3042 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3043 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
3044 } elseif ( !$token ) {
3045 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3047 $this->mToken
= $token;
3052 * Set the password for a password reminder or new account email
3054 * @deprecated Removed in 1.27. Use PasswordReset instead.
3055 * @param string $str New password to set or null to set an invalid
3056 * password hash meaning that the user will not be able to use it
3057 * @param bool $throttle If true, reset the throttle timestamp to the present
3059 public function setNewpassword( $str, $throttle = true ) {
3060 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
3064 * Get the user's e-mail address
3065 * @return string User's email address
3067 public function getEmail() {
3069 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
3070 return $this->mEmail
;
3074 * Get the timestamp of the user's e-mail authentication
3075 * @return string TS_MW timestamp
3077 public function getEmailAuthenticationTimestamp() {
3079 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
3080 return $this->mEmailAuthenticated
;
3084 * Set the user's e-mail address
3085 * @param string $str New e-mail address
3087 public function setEmail( $str ) {
3089 if ( $str == $this->mEmail
) {
3092 $this->invalidateEmail();
3093 $this->mEmail
= $str;
3094 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
3098 * Set the user's e-mail address and a confirmation mail if needed.
3101 * @param string $str New e-mail address
3104 public function setEmailWithConfirmation( $str ) {
3105 global $wgEnableEmail, $wgEmailAuthentication;
3107 if ( !$wgEnableEmail ) {
3108 return Status
::newFatal( 'emaildisabled' );
3111 $oldaddr = $this->getEmail();
3112 if ( $str === $oldaddr ) {
3113 return Status
::newGood( true );
3116 $type = $oldaddr != '' ?
'changed' : 'set';
3117 $notificationResult = null;
3119 if ( $wgEmailAuthentication && $type === 'changed' ) {
3120 // Send the user an email notifying the user of the change in registered
3121 // email address on their previous email address
3122 $change = $str != '' ?
'changed' : 'removed';
3123 $notificationResult = $this->sendMail(
3124 wfMessage( 'notificationemail_subject_' . $change )->text(),
3125 wfMessage( 'notificationemail_body_' . $change,
3126 $this->getRequest()->getIP(),
3132 $this->setEmail( $str );
3134 if ( $str !== '' && $wgEmailAuthentication ) {
3135 // Send a confirmation request to the new address if needed
3136 $result = $this->sendConfirmationMail( $type );
3138 if ( $notificationResult !== null ) {
3139 $result->merge( $notificationResult );
3142 if ( $result->isGood() ) {
3143 // Say to the caller that a confirmation and notification mail has been sent
3144 $result->value
= 'eauth';
3147 $result = Status
::newGood( true );
3154 * Get the user's real name
3155 * @return string User's real name
3157 public function getRealName() {
3158 if ( !$this->isItemLoaded( 'realname' ) ) {
3162 return $this->mRealName
;
3166 * Set the user's real name
3167 * @param string $str New real name
3169 public function setRealName( $str ) {
3171 $this->mRealName
= $str;
3175 * Get the user's current setting for a given option.
3177 * @param string $oname The option to check
3178 * @param string|array|null $defaultOverride A default value returned if the option does not exist
3179 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
3180 * @return string|array|int|null User's current value for the option
3181 * @see getBoolOption()
3182 * @see getIntOption()
3184 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
3185 global $wgHiddenPrefs;
3186 $this->loadOptions();
3188 # We want 'disabled' preferences to always behave as the default value for
3189 # users, even if they have set the option explicitly in their settings (ie they
3190 # set it, and then it was disabled removing their ability to change it). But
3191 # we don't want to erase the preferences in the database in case the preference
3192 # is re-enabled again. So don't touch $mOptions, just override the returned value
3193 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
3194 return self
::getDefaultOption( $oname );
3197 if ( array_key_exists( $oname, $this->mOptions
) ) {
3198 return $this->mOptions
[$oname];
3201 return $defaultOverride;
3205 * Get all user's options
3207 * @param int $flags Bitwise combination of:
3208 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
3209 * to the default value. (Since 1.25)
3212 public function getOptions( $flags = 0 ) {
3213 global $wgHiddenPrefs;
3214 $this->loadOptions();
3215 $options = $this->mOptions
;
3217 # We want 'disabled' preferences to always behave as the default value for
3218 # users, even if they have set the option explicitly in their settings (ie they
3219 # set it, and then it was disabled removing their ability to change it). But
3220 # we don't want to erase the preferences in the database in case the preference
3221 # is re-enabled again. So don't touch $mOptions, just override the returned value
3222 foreach ( $wgHiddenPrefs as $pref ) {
3223 $default = self
::getDefaultOption( $pref );
3224 if ( $default !== null ) {
3225 $options[$pref] = $default;
3229 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
3230 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
3237 * Get the user's current setting for a given option, as a boolean value.
3239 * @param string $oname The option to check
3240 * @return bool User's current value for the option
3243 public function getBoolOption( $oname ) {
3244 return (bool)$this->getOption( $oname );
3248 * Get the user's current setting for a given option, as an integer value.
3250 * @param string $oname The option to check
3251 * @param int $defaultOverride A default value returned if the option does not exist
3252 * @return int User's current value for the option
3255 public function getIntOption( $oname, $defaultOverride = 0 ) {
3256 $val = $this->getOption( $oname );
3258 $val = $defaultOverride;
3260 return intval( $val );
3264 * Set the given option for a user.
3266 * You need to call saveSettings() to actually write to the database.
3268 * @param string $oname The option to set
3269 * @param mixed $val New value to set
3271 public function setOption( $oname, $val ) {
3272 $this->loadOptions();
3274 // Explicitly NULL values should refer to defaults
3275 if ( is_null( $val ) ) {
3276 $val = self
::getDefaultOption( $oname );
3279 $this->mOptions
[$oname] = $val;
3283 * Get a token stored in the preferences (like the watchlist one),
3284 * resetting it if it's empty (and saving changes).
3286 * @param string $oname The option name to retrieve the token from
3287 * @return string|bool User's current value for the option, or false if this option is disabled.
3288 * @see resetTokenFromOption()
3290 * @deprecated since 1.26 Applications should use the OAuth extension
3292 public function getTokenFromOption( $oname ) {
3293 global $wgHiddenPrefs;
3295 $id = $this->getId();
3296 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
3300 $token = $this->getOption( $oname );
3302 // Default to a value based on the user token to avoid space
3303 // wasted on storing tokens for all users. When this option
3304 // is set manually by the user, only then is it stored.
3305 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
3312 * Reset a token stored in the preferences (like the watchlist one).
3313 * *Does not* save user's preferences (similarly to setOption()).
3315 * @param string $oname The option name to reset the token in
3316 * @return string|bool New token value, or false if this option is disabled.
3317 * @see getTokenFromOption()
3320 public function resetTokenFromOption( $oname ) {
3321 global $wgHiddenPrefs;
3322 if ( in_array( $oname, $wgHiddenPrefs ) ) {
3326 $token = MWCryptRand
::generateHex( 40 );
3327 $this->setOption( $oname, $token );
3332 * Return a list of the types of user options currently returned by
3333 * User::getOptionKinds().
3335 * Currently, the option kinds are:
3336 * - 'registered' - preferences which are registered in core MediaWiki or
3337 * by extensions using the UserGetDefaultOptions hook.
3338 * - 'registered-multiselect' - as above, using the 'multiselect' type.
3339 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
3340 * - 'userjs' - preferences with names starting with 'userjs-', intended to
3341 * be used by user scripts.
3342 * - 'special' - "preferences" that are not accessible via User::getOptions
3343 * or User::setOptions.
3344 * - 'unused' - preferences about which MediaWiki doesn't know anything.
3345 * These are usually legacy options, removed in newer versions.
3347 * The API (and possibly others) use this function to determine the possible
3348 * option types for validation purposes, so make sure to update this when a
3349 * new option kind is added.
3351 * @see User::getOptionKinds
3352 * @return array Option kinds
3354 public static function listOptionKinds() {
3357 'registered-multiselect',
3358 'registered-checkmatrix',
3366 * Return an associative array mapping preferences keys to the kind of a preference they're
3367 * used for. Different kinds are handled differently when setting or reading preferences.
3369 * See User::listOptionKinds for the list of valid option types that can be provided.
3371 * @see User::listOptionKinds
3372 * @param IContextSource $context
3373 * @param array|null $options Assoc. array with options keys to check as keys.
3374 * Defaults to $this->mOptions.
3375 * @return array The key => kind mapping data
3377 public function getOptionKinds( IContextSource
$context, $options = null ) {
3378 $this->loadOptions();
3379 if ( $options === null ) {
3380 $options = $this->mOptions
;
3383 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
3384 $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
3387 // Pull out the "special" options, so they don't get converted as
3388 // multiselect or checkmatrix.
3389 $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
3390 foreach ( $specialOptions as $name => $value ) {
3391 unset( $prefs[$name] );
3394 // Multiselect and checkmatrix options are stored in the database with
3395 // one key per option, each having a boolean value. Extract those keys.
3396 $multiselectOptions = [];
3397 foreach ( $prefs as $name => $info ) {
3398 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3399 ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField
::class ) ) {
3400 $opts = HTMLFormField
::flattenOptions( $info['options'] );
3401 $prefix = $info['prefix'] ??
$name;
3403 foreach ( $opts as $value ) {
3404 $multiselectOptions["$prefix$value"] = true;
3407 unset( $prefs[$name] );
3410 $checkmatrixOptions = [];
3411 foreach ( $prefs as $name => $info ) {
3412 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3413 ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix
::class ) ) {
3414 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3415 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3416 $prefix = $info['prefix'] ??
$name;
3418 foreach ( $columns as $column ) {
3419 foreach ( $rows as $row ) {
3420 $checkmatrixOptions["$prefix$column-$row"] = true;
3424 unset( $prefs[$name] );
3428 // $value is ignored
3429 foreach ( $options as $key => $value ) {
3430 if ( isset( $prefs[$key] ) ) {
3431 $mapping[$key] = 'registered';
3432 } elseif ( isset( $multiselectOptions[$key] ) ) {
3433 $mapping[$key] = 'registered-multiselect';
3434 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3435 $mapping[$key] = 'registered-checkmatrix';
3436 } elseif ( isset( $specialOptions[$key] ) ) {
3437 $mapping[$key] = 'special';
3438 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3439 $mapping[$key] = 'userjs';
3441 $mapping[$key] = 'unused';
3449 * Reset certain (or all) options to the site defaults
3451 * The optional parameter determines which kinds of preferences will be reset.
3452 * Supported values are everything that can be reported by getOptionKinds()
3453 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3455 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3456 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3457 * for backwards-compatibility.
3458 * @param IContextSource|null $context Context source used when $resetKinds
3459 * does not contain 'all', passed to getOptionKinds().
3460 * Defaults to RequestContext::getMain() when null.
3462 public function resetOptions(
3463 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3464 IContextSource
$context = null
3467 $defaultOptions = self
::getDefaultOptions();
3469 if ( !is_array( $resetKinds ) ) {
3470 $resetKinds = [ $resetKinds ];
3473 if ( in_array( 'all', $resetKinds ) ) {
3474 $newOptions = $defaultOptions;
3476 if ( $context === null ) {
3477 $context = RequestContext
::getMain();
3480 $optionKinds = $this->getOptionKinds( $context );
3481 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3484 // Use default values for the options that should be deleted, and
3485 // copy old values for the ones that shouldn't.
3486 foreach ( $this->mOptions
as $key => $value ) {
3487 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3488 if ( array_key_exists( $key, $defaultOptions ) ) {
3489 $newOptions[$key] = $defaultOptions[$key];
3492 $newOptions[$key] = $value;
3497 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3499 $this->mOptions
= $newOptions;
3500 $this->mOptionsLoaded
= true;
3504 * Get the user's preferred date format.
3505 * @return string User's preferred date format
3507 public function getDatePreference() {
3508 // Important migration for old data rows
3509 if ( is_null( $this->mDatePreference
) ) {
3511 $value = $this->getOption( 'date' );
3512 $map = $wgLang->getDatePreferenceMigrationMap();
3513 if ( isset( $map[$value] ) ) {
3514 $value = $map[$value];
3516 $this->mDatePreference
= $value;
3518 return $this->mDatePreference
;
3522 * Determine based on the wiki configuration and the user's options,
3523 * whether this user must be over HTTPS no matter what.
3527 public function requiresHTTPS() {
3528 global $wgSecureLogin;
3529 if ( !$wgSecureLogin ) {
3533 $https = $this->getBoolOption( 'prefershttps' );
3534 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3536 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3543 * Get the user preferred stub threshold
3547 public function getStubThreshold() {
3548 global $wgMaxArticleSize; # Maximum article size, in Kb
3549 $threshold = $this->getIntOption( 'stubthreshold' );
3550 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3551 // If they have set an impossible value, disable the preference
3552 // so we can use the parser cache again.
3559 * Get the permissions this user has.
3560 * @return string[] permission names
3562 public function getRights() {
3563 if ( is_null( $this->mRights
) ) {
3564 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3565 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3567 // Deny any rights denied by the user's session, unless this
3568 // endpoint has no sessions.
3569 if ( !defined( 'MW_NO_SESSION' ) ) {
3570 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3571 if ( $allowedRights !== null ) {
3572 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3576 Hooks
::run( 'UserGetRightsRemove', [ $this, &$this->mRights
] );
3577 // Force reindexation of rights when a hook has unset one of them
3578 $this->mRights
= array_values( array_unique( $this->mRights
) );
3580 // If block disables login, we should also remove any
3581 // extra rights blocked users might have, in case the
3582 // blocked user has a pre-existing session (T129738).
3583 // This is checked here for cases where people only call
3584 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3585 // to give a better error message in the common case.
3586 $config = RequestContext
::getMain()->getConfig();
3588 $this->isLoggedIn() &&
3589 $config->get( 'BlockDisablesLogin' ) &&
3593 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3596 return $this->mRights
;
3600 * Get the list of explicit group memberships this user has.
3601 * The implicit * and user groups are not included.
3603 * @return string[] Array of internal group names (sorted since 1.33)
3605 public function getGroups() {
3607 $this->loadGroups();
3608 return array_keys( $this->mGroupMemberships
);
3612 * Get the list of explicit group memberships this user has, stored as
3613 * UserGroupMembership objects. Implicit groups are not included.
3615 * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
3618 public function getGroupMemberships() {
3620 $this->loadGroups();
3621 return $this->mGroupMemberships
;
3625 * Get the list of implicit group memberships this user has.
3626 * This includes all explicit groups, plus 'user' if logged in,
3627 * '*' for all accounts, and autopromoted groups
3628 * @param bool $recache Whether to avoid the cache
3629 * @return array Array of String internal group names
3631 public function getEffectiveGroups( $recache = false ) {
3632 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3633 $this->mEffectiveGroups
= array_unique( array_merge(
3634 $this->getGroups(), // explicit groups
3635 $this->getAutomaticGroups( $recache ) // implicit groups
3637 // Avoid PHP 7.1 warning of passing $this by reference
3639 // Hook for additional groups
3640 Hooks
::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups
] );
3641 // Force reindexation of groups when a hook has unset one of them
3642 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3644 return $this->mEffectiveGroups
;
3648 * Get the list of implicit group memberships this user has.
3649 * This includes 'user' if logged in, '*' for all accounts,
3650 * and autopromoted groups
3651 * @param bool $recache Whether to avoid the cache
3652 * @return array Array of String internal group names
3654 public function getAutomaticGroups( $recache = false ) {
3655 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3656 $this->mImplicitGroups
= [ '*' ];
3657 if ( $this->getId() ) {
3658 $this->mImplicitGroups
[] = 'user';
3660 $this->mImplicitGroups
= array_unique( array_merge(
3661 $this->mImplicitGroups
,
3662 Autopromote
::getAutopromoteGroups( $this )
3666 // Assure data consistency with rights/groups,
3667 // as getEffectiveGroups() depends on this function
3668 $this->mEffectiveGroups
= null;
3671 return $this->mImplicitGroups
;
3675 * Returns the groups the user has belonged to.
3677 * The user may still belong to the returned groups. Compare with getGroups().
3679 * The function will not return groups the user had belonged to before MW 1.17
3681 * @return array Names of the groups the user has belonged to.
3683 public function getFormerGroups() {
3686 if ( is_null( $this->mFormerGroups
) ) {
3687 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3688 ?
wfGetDB( DB_MASTER
)
3689 : wfGetDB( DB_REPLICA
);
3690 $res = $db->select( 'user_former_groups',
3692 [ 'ufg_user' => $this->mId
],
3694 $this->mFormerGroups
= [];
3695 foreach ( $res as $row ) {
3696 $this->mFormerGroups
[] = $row->ufg_group
;
3700 return $this->mFormerGroups
;
3704 * Get the user's edit count.
3705 * @return int|null Null for anonymous users
3707 public function getEditCount() {
3708 if ( !$this->getId() ) {
3712 if ( $this->mEditCount
=== null ) {
3713 /* Populate the count, if it has not been populated yet */
3714 $dbr = wfGetDB( DB_REPLICA
);
3715 // check if the user_editcount field has been initialized
3716 $count = $dbr->selectField(
3717 'user', 'user_editcount',
3718 [ 'user_id' => $this->mId
],
3722 if ( $count === null ) {
3723 // it has not been initialized. do so.
3724 $count = $this->initEditCountInternal();
3726 $this->mEditCount
= $count;
3728 return (int)$this->mEditCount
;
3732 * Add the user to the given group. This takes immediate effect.
3733 * If the user is already in the group, the expiry time will be updated to the new
3734 * expiry time. (If $expiry is omitted or null, the membership will be altered to
3737 * @param string $group Name of the group to add
3738 * @param string|null $expiry Optional expiry timestamp in any format acceptable to
3739 * wfTimestamp(), or null if the group assignment should not expire
3742 public function addGroup( $group, $expiry = null ) {
3744 $this->loadGroups();
3747 $expiry = wfTimestamp( TS_MW
, $expiry );
3750 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
3754 // create the new UserGroupMembership and put it in the DB
3755 $ugm = new UserGroupMembership( $this->mId
, $group, $expiry );
3756 if ( !$ugm->insert( true ) ) {
3760 $this->mGroupMemberships
[$group] = $ugm;
3762 // Refresh the groups caches, and clear the rights cache so it will be
3763 // refreshed on the next call to $this->getRights().
3764 $this->getEffectiveGroups( true );
3765 $this->mRights
= null;
3767 $this->invalidateCache();
3773 * Remove the user from the given group.
3774 * This takes immediate effect.
3775 * @param string $group Name of the group to remove
3778 public function removeGroup( $group ) {
3781 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3785 $ugm = UserGroupMembership
::getMembership( $this->mId
, $group );
3786 // delete the membership entry
3787 if ( !$ugm ||
!$ugm->delete() ) {
3791 $this->loadGroups();
3792 unset( $this->mGroupMemberships
[$group] );
3794 // Refresh the groups caches, and clear the rights cache so it will be
3795 // refreshed on the next call to $this->getRights().
3796 $this->getEffectiveGroups( true );
3797 $this->mRights
= null;
3799 $this->invalidateCache();
3805 * Get whether the user is logged in
3808 public function isLoggedIn() {
3809 return $this->getId() != 0;
3813 * Get whether the user is anonymous
3816 public function isAnon() {
3817 return !$this->isLoggedIn();
3821 * @return bool Whether this user is flagged as being a bot role account
3824 public function isBot() {
3825 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3830 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3836 * Check if user is allowed to access a feature / make an action
3838 * @param string $permissions,... Permissions to test
3839 * @return bool True if user is allowed to perform *any* of the given actions
3841 public function isAllowedAny() {
3842 $permissions = func_get_args();
3843 foreach ( $permissions as $permission ) {
3844 if ( $this->isAllowed( $permission ) ) {
3853 * @param string $permissions,... Permissions to test
3854 * @return bool True if the user is allowed to perform *all* of the given actions
3856 public function isAllowedAll() {
3857 $permissions = func_get_args();
3858 foreach ( $permissions as $permission ) {
3859 if ( !$this->isAllowed( $permission ) ) {
3867 * Internal mechanics of testing a permission
3868 * @param string $action
3871 public function isAllowed( $action = '' ) {
3872 if ( $action === '' ) {
3873 return true; // In the spirit of DWIM
3875 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3876 // by misconfiguration: 0 == 'foo'
3877 return in_array( $action, $this->getRights(), true );
3881 * Check whether to enable recent changes patrol features for this user
3882 * @return bool True or false
3884 public function useRCPatrol() {
3885 global $wgUseRCPatrol;
3886 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3890 * Check whether to enable new pages patrol features for this user
3891 * @return bool True or false
3893 public function useNPPatrol() {
3894 global $wgUseRCPatrol, $wgUseNPPatrol;
3896 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3897 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3902 * Check whether to enable new files patrol features for this user
3903 * @return bool True or false
3905 public function useFilePatrol() {
3906 global $wgUseRCPatrol, $wgUseFilePatrol;
3908 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3909 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3914 * Get the WebRequest object to use with this object
3916 * @return WebRequest
3918 public function getRequest() {
3919 if ( $this->mRequest
) {
3920 return $this->mRequest
;
3928 * Check the watched status of an article.
3929 * @since 1.22 $checkRights parameter added
3930 * @param Title $title Title of the article to look at
3931 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3932 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3935 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3936 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3937 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3944 * @since 1.22 $checkRights parameter added
3945 * @param Title $title Title of the article to look at
3946 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3947 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3949 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3950 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3951 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3953 [ $title->getSubjectPage(), $title->getTalkPage() ]
3956 $this->invalidateCache();
3960 * Stop watching an article.
3961 * @since 1.22 $checkRights parameter added
3962 * @param Title $title Title of the article to look at
3963 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3964 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3966 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3967 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3968 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3969 $store->removeWatch( $this, $title->getSubjectPage() );
3970 $store->removeWatch( $this, $title->getTalkPage() );
3972 $this->invalidateCache();
3976 * Clear the user's notification timestamp for the given title.
3977 * If e-notif e-mails are on, they will receive notification mails on
3978 * the next change of the page if it's watched etc.
3979 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3980 * @param Title &$title Title of the article to look at
3981 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3983 public function clearNotification( &$title, $oldid = 0 ) {
3984 global $wgUseEnotif, $wgShowUpdatedMarker;
3986 // Do nothing if the database is locked to writes
3987 if ( wfReadOnly() ) {
3991 // Do nothing if not allowed to edit the watchlist
3992 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3996 // If we're working on user's talk page, we should update the talk page message indicator
3997 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3998 // Avoid PHP 7.1 warning of passing $this by reference
4000 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
4004 // Try to update the DB post-send and only if needed...
4005 DeferredUpdates
::addCallableUpdate( function () use ( $title, $oldid ) {
4006 if ( !$this->getNewtalk() ) {
4007 return; // no notifications to clear
4010 // Delete the last notifications (they stack up)
4011 $this->setNewtalk( false );
4013 // If there is a new, unseen, revision, use its timestamp
4015 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
4018 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
4023 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4027 if ( $this->isAnon() ) {
4028 // Nothing else to do...
4032 // Only update the timestamp if the page is being watched.
4033 // The query to find out if it is watched is cached both in memcached and per-invocation,
4034 // and when it does have to be executed, it can be on a replica DB
4035 // If this is the user's newtalk page, we always update the timestamp
4037 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
4041 MediaWikiServices
::getInstance()->getWatchedItemStore()
4042 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
4046 * Resets all of the given user's page-change notification timestamps.
4047 * If e-notif e-mails are on, they will receive notification mails on
4048 * the next change of any watched page.
4049 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
4051 public function clearAllNotifications() {
4052 global $wgUseEnotif, $wgShowUpdatedMarker;
4053 // Do nothing if not allowed to edit the watchlist
4054 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
4058 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4059 $this->setNewtalk( false );
4063 $id = $this->getId();
4068 $watchedItemStore = MediaWikiServices
::getInstance()->getWatchedItemStore();
4069 $watchedItemStore->resetAllNotificationTimestampsForUser( $this );
4071 // We also need to clear here the "you have new message" notification for the own
4072 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
4076 * Compute experienced level based on edit count and registration date.
4078 * @return string 'newcomer', 'learner', or 'experienced'
4080 public function getExperienceLevel() {
4081 global $wgLearnerEdits,
4082 $wgExperiencedUserEdits,
4083 $wgLearnerMemberSince,
4084 $wgExperiencedUserMemberSince;
4086 if ( $this->isAnon() ) {
4090 $editCount = $this->getEditCount();
4091 $registration = $this->getRegistration();
4093 $learnerRegistration = wfTimestamp( TS_MW
, $now - $wgLearnerMemberSince * 86400 );
4094 $experiencedRegistration = wfTimestamp( TS_MW
, $now - $wgExperiencedUserMemberSince * 86400 );
4096 if ( $editCount < $wgLearnerEdits ||
4097 $registration > $learnerRegistration ) {
4101 if ( $editCount > $wgExperiencedUserEdits &&
4102 $registration <= $experiencedRegistration
4104 return 'experienced';
4111 * Persist this user's session (e.g. set cookies)
4113 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
4115 * @param bool|null $secure Whether to force secure/insecure cookies or use default
4116 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
4118 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
4120 if ( $this->mId
== 0 ) {
4124 $session = $this->getRequest()->getSession();
4125 if ( $request && $session->getRequest() !== $request ) {
4126 $session = $session->sessionWithRequest( $request );
4128 $delay = $session->delaySave();
4130 if ( !$session->getUser()->equals( $this ) ) {
4131 if ( !$session->canSetUser() ) {
4132 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4133 ->warning( __METHOD__
.
4134 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
4138 $session->setUser( $this );
4141 $session->setRememberUser( $rememberMe );
4142 if ( $secure !== null ) {
4143 $session->setForceHTTPS( $secure );
4146 $session->persist();
4148 ScopedCallback
::consume( $delay );
4152 * Log this user out.
4154 public function logout() {
4155 // Avoid PHP 7.1 warning of passing $this by reference
4157 if ( Hooks
::run( 'UserLogout', [ &$user ] ) ) {
4163 * Clear the user's session, and reset the instance cache.
4166 public function doLogout() {
4167 $session = $this->getRequest()->getSession();
4168 if ( !$session->canSetUser() ) {
4169 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4170 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
4171 $error = 'immutable';
4172 } elseif ( !$session->getUser()->equals( $this ) ) {
4173 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4174 ->warning( __METHOD__
.
4175 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
4177 // But we still may as well make this user object anon
4178 $this->clearInstanceCache( 'defaults' );
4179 $error = 'wronguser';
4181 $this->clearInstanceCache( 'defaults' );
4182 $delay = $session->delaySave();
4183 $session->unpersist(); // Clear cookies (T127436)
4184 $session->setLoggedOutTimestamp( time() );
4185 $session->setUser( new User
);
4186 $session->set( 'wsUserID', 0 ); // Other code expects this
4187 $session->resetAllTokens();
4188 ScopedCallback
::consume( $delay );
4191 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
4192 'event' => 'logout',
4193 'successful' => $error === false,
4194 'status' => $error ?
: 'success',
4199 * Save this user's settings into the database.
4200 * @todo Only rarely do all these fields need to be set!
4202 public function saveSettings() {
4203 if ( wfReadOnly() ) {
4204 // @TODO: caller should deal with this instead!
4205 // This should really just be an exception.
4206 MWExceptionHandler
::logException( new DBExpectedError(
4208 "Could not update user with ID '{$this->mId}'; DB is read-only."
4214 if ( $this->mId
== 0 ) {
4218 // Get a new user_touched that is higher than the old one.
4219 // This will be used for a CAS check as a last-resort safety
4220 // check against race conditions and replica DB lag.
4221 $newTouched = $this->newTouchedTimestamp();
4223 $dbw = wfGetDB( DB_MASTER
);
4224 $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $newTouched ) {
4225 global $wgActorTableSchemaMigrationStage;
4227 $dbw->update( 'user',
4229 'user_name' => $this->mName
,
4230 'user_real_name' => $this->mRealName
,
4231 'user_email' => $this->mEmail
,
4232 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4233 'user_touched' => $dbw->timestamp( $newTouched ),
4234 'user_token' => strval( $this->mToken
),
4235 'user_email_token' => $this->mEmailToken
,
4236 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
4237 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
4238 'user_id' => $this->mId
,
4242 if ( !$dbw->affectedRows() ) {
4243 // Maybe the problem was a missed cache update; clear it to be safe
4244 $this->clearSharedCache( 'refresh' );
4245 // User was changed in the meantime or loaded with stale data
4246 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
4247 LoggerFactory
::getInstance( 'preferences' )->warning(
4248 "CAS update failed on user_touched for user ID '{user_id}' ({db_flag} read)",
4249 [ 'user_id' => $this->mId
, 'db_flag' => $from ]
4251 throw new MWException( "CAS update failed on user_touched. " .
4252 "The version of the user to be saved is older than the current version."
4256 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4259 [ 'actor_name' => $this->mName
],
4260 [ 'actor_user' => $this->mId
],
4266 $this->mTouched
= $newTouched;
4267 $this->saveOptions();
4269 Hooks
::run( 'UserSaveSettings', [ $this ] );
4270 $this->clearSharedCache();
4271 $this->getUserPage()->purgeSquid();
4275 * If only this user's username is known, and it exists, return the user ID.
4277 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
4280 public function idForName( $flags = 0 ) {
4281 $s = trim( $this->getName() );
4286 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
4287 ?
wfGetDB( DB_MASTER
)
4288 : wfGetDB( DB_REPLICA
);
4290 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
4291 ?
[ 'LOCK IN SHARE MODE' ]
4294 $id = $db->selectField( 'user',
4295 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
4301 * Add a user to the database, return the user object
4303 * @param string $name Username to add
4304 * @param array $params Array of Strings Non-default parameters to save to
4305 * the database as user_* fields:
4306 * - email: The user's email address.
4307 * - email_authenticated: The email authentication timestamp.
4308 * - real_name: The user's real name.
4309 * - options: An associative array of non-default options.
4310 * - token: Random authentication token. Do not set.
4311 * - registration: Registration timestamp. Do not set.
4313 * @return User|null User object, or null if the username already exists.
4315 public static function createNew( $name, $params = [] ) {
4316 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
4317 if ( isset( $params[$field] ) ) {
4318 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
4319 unset( $params[$field] );
4325 $user->setToken(); // init token
4326 if ( isset( $params['options'] ) ) {
4327 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
4328 unset( $params['options'] );
4330 $dbw = wfGetDB( DB_MASTER
);
4332 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4335 'user_name' => $name,
4336 'user_password' => $noPass,
4337 'user_newpassword' => $noPass,
4338 'user_email' => $user->mEmail
,
4339 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
4340 'user_real_name' => $user->mRealName
,
4341 'user_token' => strval( $user->mToken
),
4342 'user_registration' => $dbw->timestamp( $user->mRegistration
),
4343 'user_editcount' => 0,
4344 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4346 foreach ( $params as $name => $value ) {
4347 $fields["user_$name"] = $value;
4350 return $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $fields ) {
4351 $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
4352 if ( $dbw->affectedRows() ) {
4353 $newUser = self
::newFromId( $dbw->insertId() );
4354 $newUser->mName
= $fields['user_name'];
4355 $newUser->updateActorId( $dbw );
4356 // Load the user from master to avoid replica lag
4357 $newUser->load( self
::READ_LATEST
);
4366 * Add this existing user object to the database. If the user already
4367 * exists, a fatal status object is returned, and the user object is
4368 * initialised with the data from the database.
4370 * Previously, this function generated a DB error due to a key conflict
4371 * if the user already existed. Many extension callers use this function
4372 * in code along the lines of:
4374 * $user = User::newFromName( $name );
4375 * if ( !$user->isLoggedIn() ) {
4376 * $user->addToDatabase();
4378 * // do something with $user...
4380 * However, this was vulnerable to a race condition (T18020). By
4381 * initialising the user object if the user exists, we aim to support this
4382 * calling sequence as far as possible.
4384 * Note that if the user exists, this function will acquire a write lock,
4385 * so it is still advisable to make the call conditional on isLoggedIn(),
4386 * and to commit the transaction after calling.
4388 * @throws MWException
4391 public function addToDatabase() {
4393 if ( !$this->mToken
) {
4394 $this->setToken(); // init token
4397 if ( !is_string( $this->mName
) ) {
4398 throw new RuntimeException( "User name field is not set." );
4401 $this->mTouched
= $this->newTouchedTimestamp();
4403 $dbw = wfGetDB( DB_MASTER
);
4404 $status = $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) {
4405 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4406 $dbw->insert( 'user',
4408 'user_name' => $this->mName
,
4409 'user_password' => $noPass,
4410 'user_newpassword' => $noPass,
4411 'user_email' => $this->mEmail
,
4412 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4413 'user_real_name' => $this->mRealName
,
4414 'user_token' => strval( $this->mToken
),
4415 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4416 'user_editcount' => 0,
4417 'user_touched' => $dbw->timestamp( $this->mTouched
),
4421 if ( !$dbw->affectedRows() ) {
4422 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4423 $this->mId
= $dbw->selectField(
4426 [ 'user_name' => $this->mName
],
4428 [ 'LOCK IN SHARE MODE' ]
4432 if ( $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4437 throw new MWException( $fname . ": hit a key conflict attempting " .
4438 "to insert user '{$this->mName}' row, but it was not present in select!" );
4440 return Status
::newFatal( 'userexists' );
4442 $this->mId
= $dbw->insertId();
4443 self
::$idCacheByName[$this->mName
] = $this->mId
;
4444 $this->updateActorId( $dbw );
4446 return Status
::newGood();
4448 if ( !$status->isGood() ) {
4452 // Clear instance cache other than user table data and actor, which is already accurate
4453 $this->clearInstanceCache();
4455 $this->saveOptions();
4456 return Status
::newGood();
4460 * Update the actor ID after an insert
4461 * @param IDatabase $dbw Writable database handle
4463 private function updateActorId( IDatabase
$dbw ) {
4464 global $wgActorTableSchemaMigrationStage;
4466 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4469 [ 'actor_user' => $this->mId
, 'actor_name' => $this->mName
],
4472 $this->mActorId
= (int)$dbw->insertId();
4477 * If this user is logged-in and blocked,
4478 * block any IP address they've successfully logged in from.
4479 * @return bool A block was spread
4481 public function spreadAnyEditBlock() {
4482 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4483 return $this->spreadBlock();
4490 * If this (non-anonymous) user is blocked,
4491 * block the IP address they've successfully logged in from.
4492 * @return bool A block was spread
4494 protected function spreadBlock() {
4495 wfDebug( __METHOD__
. "()\n" );
4497 if ( $this->mId
== 0 ) {
4501 $userblock = Block
::newFromTarget( $this->getName() );
4502 if ( !$userblock ) {
4506 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4510 * Get whether the user is explicitly blocked from account creation.
4511 * @return bool|Block
4513 public function isBlockedFromCreateAccount() {
4514 $this->getBlockedStatus();
4515 if ( $this->mBlock
&& $this->mBlock
->appliesToRight( 'createaccount' ) ) {
4516 return $this->mBlock
;
4519 # T15611: if the IP address the user is trying to create an account from is
4520 # blocked with createaccount disabled, prevent new account creation there even
4521 # when the user is logged in
4522 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4523 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4525 return $this->mBlockedFromCreateAccount
instanceof Block
4526 && $this->mBlockedFromCreateAccount
->appliesToRight( 'createaccount' )
4527 ?
$this->mBlockedFromCreateAccount
4532 * Get whether the user is blocked from using Special:Emailuser.
4535 public function isBlockedFromEmailuser() {
4536 $this->getBlockedStatus();
4537 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'sendemail' );
4541 * Get whether the user is blocked from using Special:Upload
4546 public function isBlockedFromUpload() {
4547 $this->getBlockedStatus();
4548 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'upload' );
4552 * Get whether the user is allowed to create an account.
4555 public function isAllowedToCreateAccount() {
4556 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4560 * Get this user's personal page title.
4562 * @return Title User's personal page title
4564 public function getUserPage() {
4565 return Title
::makeTitle( NS_USER
, $this->getName() );
4569 * Get this user's talk page title.
4571 * @return Title User's talk page title
4573 public function getTalkPage() {
4574 $title = $this->getUserPage();
4575 return $title->getTalkPage();
4579 * Determine whether the user is a newbie. Newbies are either
4580 * anonymous IPs, or the most recently created accounts.
4583 public function isNewbie() {
4584 return !$this->isAllowed( 'autoconfirmed' );
4588 * Check to see if the given clear-text password is one of the accepted passwords
4589 * @deprecated since 1.27, use AuthManager instead
4590 * @param string $password User password
4591 * @return bool True if the given password is correct, otherwise False
4593 public function checkPassword( $password ) {
4594 wfDeprecated( __METHOD__
, '1.27' );
4596 $manager = AuthManager
::singleton();
4597 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4598 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4600 'username' => $this->getName(),
4601 'password' => $password,
4604 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4605 switch ( $res->status
) {
4606 case AuthenticationResponse
::PASS
:
4608 case AuthenticationResponse
::FAIL
:
4609 // Hope it's not a PreAuthenticationProvider that failed...
4610 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4611 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4614 throw new BadMethodCallException(
4615 'AuthManager returned a response unsupported by ' . __METHOD__
4621 * Check if the given clear-text password matches the temporary password
4622 * sent by e-mail for password reset operations.
4624 * @deprecated since 1.27, use AuthManager instead
4625 * @param string $plaintext
4626 * @return bool True if matches, false otherwise
4628 public function checkTemporaryPassword( $plaintext ) {
4629 wfDeprecated( __METHOD__
, '1.27' );
4630 // Can't check the temporary password individually.
4631 return $this->checkPassword( $plaintext );
4635 * Initialize (if necessary) and return a session token value
4636 * which can be used in edit forms to show that the user's
4637 * login credentials aren't being hijacked with a foreign form
4641 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4642 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4643 * @return MediaWiki\Session\Token The new edit token
4645 public function getEditTokenObject( $salt = '', $request = null ) {
4646 if ( $this->isAnon() ) {
4647 return new LoggedOutEditToken();
4651 $request = $this->getRequest();
4653 return $request->getSession()->getToken( $salt );
4657 * Initialize (if necessary) and return a session token value
4658 * which can be used in edit forms to show that the user's
4659 * login credentials aren't being hijacked with a foreign form
4662 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4665 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4666 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4667 * @return string The new edit token
4669 public function getEditToken( $salt = '', $request = null ) {
4670 return $this->getEditTokenObject( $salt, $request )->toString();
4674 * Check given value against the token value stored in the session.
4675 * A match should confirm that the form was submitted from the
4676 * user's own login session, not a form submission from a third-party
4679 * @param string $val Input value to compare
4680 * @param string|array $salt Optional function-specific data for hashing
4681 * @param WebRequest|null $request Object to use or null to use $wgRequest
4682 * @param int|null $maxage Fail tokens older than this, in seconds
4683 * @return bool Whether the token matches
4685 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4686 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4690 * Check given value against the token value stored in the session,
4691 * ignoring the suffix.
4693 * @param string $val Input value to compare
4694 * @param string|array $salt Optional function-specific data for hashing
4695 * @param WebRequest|null $request Object to use or null to use $wgRequest
4696 * @param int|null $maxage Fail tokens older than this, in seconds
4697 * @return bool Whether the token matches
4699 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4700 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4701 return $this->matchEditToken( $val, $salt, $request, $maxage );
4705 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4706 * mail to the user's given address.
4708 * @param string $type Message to send, either "created", "changed" or "set"
4711 public function sendConfirmationMail( $type = 'created' ) {
4713 $expiration = null; // gets passed-by-ref and defined in next line.
4714 $token = $this->confirmationToken( $expiration );
4715 $url = $this->confirmationTokenUrl( $token );
4716 $invalidateURL = $this->invalidationTokenUrl( $token );
4717 $this->saveSettings();
4719 if ( $type == 'created' ||
$type === false ) {
4720 $message = 'confirmemail_body';
4722 } elseif ( $type === true ) {
4723 $message = 'confirmemail_body_changed';
4726 // Messages: confirmemail_body_changed, confirmemail_body_set
4727 $message = 'confirmemail_body_' . $type;
4731 'subject' => wfMessage( 'confirmemail_subject' )->text(),
4732 'body' => wfMessage( $message,
4733 $this->getRequest()->getIP(),
4736 $wgLang->userTimeAndDate( $expiration, $this ),
4738 $wgLang->userDate( $expiration, $this ),
4739 $wgLang->userTime( $expiration, $this ) )->text(),
4745 'ip' => $this->getRequest()->getIP(),
4746 'confirmURL' => $url,
4747 'invalidateURL' => $invalidateURL,
4748 'expiration' => $expiration
4751 Hooks
::run( 'UserSendConfirmationMail', [ $this, &$mail, $info ] );
4752 return $this->sendMail( $mail['subject'], $mail['body'], $mail['from'], $mail['replyTo'] );
4756 * Send an e-mail to this user's account. Does not check for
4757 * confirmed status or validity.
4759 * @param string $subject Message subject
4760 * @param string $body Message body
4761 * @param User|null $from Optional sending user; if unspecified, default
4762 * $wgPasswordSender will be used.
4763 * @param MailAddress|null $replyto Reply-To address
4766 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4767 global $wgPasswordSender;
4769 if ( $from instanceof User
) {
4770 $sender = MailAddress
::newFromUser( $from );
4772 $sender = new MailAddress( $wgPasswordSender,
4773 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4775 $to = MailAddress
::newFromUser( $this );
4777 return UserMailer
::send( $to, $sender, $subject, $body, [
4778 'replyTo' => $replyto,
4783 * Generate, store, and return a new e-mail confirmation code.
4784 * A hash (unsalted, since it's used as a key) is stored.
4786 * @note Call saveSettings() after calling this function to commit
4787 * this change to the database.
4789 * @param string &$expiration Accepts the expiration time
4790 * @return string New token
4792 protected function confirmationToken( &$expiration ) {
4793 global $wgUserEmailConfirmationTokenExpiry;
4795 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4796 $expiration = wfTimestamp( TS_MW
, $expires );
4798 $token = MWCryptRand
::generateHex( 32 );
4799 $hash = md5( $token );
4800 $this->mEmailToken
= $hash;
4801 $this->mEmailTokenExpires
= $expiration;
4806 * Return a URL the user can use to confirm their email address.
4807 * @param string $token Accepts the email confirmation token
4808 * @return string New token URL
4810 protected function confirmationTokenUrl( $token ) {
4811 return $this->getTokenUrl( 'ConfirmEmail', $token );
4815 * Return a URL the user can use to invalidate their email address.
4816 * @param string $token Accepts the email confirmation token
4817 * @return string New token URL
4819 protected function invalidationTokenUrl( $token ) {
4820 return $this->getTokenUrl( 'InvalidateEmail', $token );
4824 * Internal function to format the e-mail validation/invalidation URLs.
4825 * This uses a quickie hack to use the
4826 * hardcoded English names of the Special: pages, for ASCII safety.
4828 * @note Since these URLs get dropped directly into emails, using the
4829 * short English names avoids insanely long URL-encoded links, which
4830 * also sometimes can get corrupted in some browsers/mailers
4831 * (T8957 with Gmail and Internet Explorer).
4833 * @param string $page Special page
4834 * @param string $token
4835 * @return string Formatted URL
4837 protected function getTokenUrl( $page, $token ) {
4838 // Hack to bypass localization of 'Special:'
4839 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4840 return $title->getCanonicalURL();
4844 * Mark the e-mail address confirmed.
4846 * @note Call saveSettings() after calling this function to commit the change.
4850 public function confirmEmail() {
4851 // Check if it's already confirmed, so we don't touch the database
4852 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4853 if ( !$this->isEmailConfirmed() ) {
4854 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4855 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4861 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4862 * address if it was already confirmed.
4864 * @note Call saveSettings() after calling this function to commit the change.
4865 * @return bool Returns true
4867 public function invalidateEmail() {
4869 $this->mEmailToken
= null;
4870 $this->mEmailTokenExpires
= null;
4871 $this->setEmailAuthenticationTimestamp( null );
4873 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4878 * Set the e-mail authentication timestamp.
4879 * @param string $timestamp TS_MW timestamp
4881 public function setEmailAuthenticationTimestamp( $timestamp ) {
4883 $this->mEmailAuthenticated
= $timestamp;
4884 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4888 * Is this user allowed to send e-mails within limits of current
4889 * site configuration?
4892 public function canSendEmail() {
4893 global $wgEnableEmail, $wgEnableUserEmail;
4894 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4897 $canSend = $this->isEmailConfirmed();
4898 // Avoid PHP 7.1 warning of passing $this by reference
4900 Hooks
::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
4905 * Is this user allowed to receive e-mails within limits of current
4906 * site configuration?
4909 public function canReceiveEmail() {
4910 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4914 * Is this user's e-mail address valid-looking and confirmed within
4915 * limits of the current site configuration?
4917 * @note If $wgEmailAuthentication is on, this may require the user to have
4918 * confirmed their address by returning a code or using a password
4919 * sent to the address from the wiki.
4923 public function isEmailConfirmed() {
4924 global $wgEmailAuthentication;
4926 // Avoid PHP 7.1 warning of passing $this by reference
4929 if ( Hooks
::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
4930 if ( $this->isAnon() ) {
4933 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4936 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4946 * Check whether there is an outstanding request for e-mail confirmation.
4949 public function isEmailConfirmationPending() {
4950 global $wgEmailAuthentication;
4951 return $wgEmailAuthentication &&
4952 !$this->isEmailConfirmed() &&
4953 $this->mEmailToken
&&
4954 $this->mEmailTokenExpires
> wfTimestamp();
4958 * Get the timestamp of account creation.
4960 * @return string|bool|null Timestamp of account creation, false for
4961 * non-existent/anonymous user accounts, or null if existing account
4962 * but information is not in database.
4964 public function getRegistration() {
4965 if ( $this->isAnon() ) {
4969 return $this->mRegistration
;
4973 * Get the timestamp of the first edit
4975 * @return string|bool Timestamp of first edit, or false for
4976 * non-existent/anonymous user accounts.
4978 public function getFirstEditTimestamp() {
4979 return $this->getEditTimestamp( true );
4983 * Get the timestamp of the latest edit
4986 * @return string|bool Timestamp of first edit, or false for
4987 * non-existent/anonymous user accounts.
4989 public function getLatestEditTimestamp() {
4990 return $this->getEditTimestamp( false );
4994 * Get the timestamp of the first or latest edit
4996 * @param bool $first True for the first edit, false for the latest one
4997 * @return string|bool Timestamp of first or latest edit, or false for
4998 * non-existent/anonymous user accounts.
5000 private function getEditTimestamp( $first ) {
5001 if ( $this->getId() == 0 ) {
5002 return false; // anons
5004 $dbr = wfGetDB( DB_REPLICA
);
5005 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5006 $tsField = isset( $actorWhere['tables']['temp_rev_user'] )
5007 ?
'revactor_timestamp' : 'rev_timestamp';
5008 $sortOrder = $first ?
'ASC' : 'DESC';
5009 $time = $dbr->selectField(
5010 [ 'revision' ] +
$actorWhere['tables'],
5012 [ $actorWhere['conds'] ],
5014 [ 'ORDER BY' => "$tsField $sortOrder" ],
5015 $actorWhere['joins']
5018 return false; // no edits
5020 return wfTimestamp( TS_MW
, $time );
5024 * Get the permissions associated with a given list of groups
5026 * @param array $groups Array of Strings List of internal group names
5027 * @return array Array of Strings List of permission key names for given groups combined
5029 public static function getGroupPermissions( $groups ) {
5030 global $wgGroupPermissions, $wgRevokePermissions;
5032 // grant every granted permission first
5033 foreach ( $groups as $group ) {
5034 if ( isset( $wgGroupPermissions[$group] ) ) {
5035 $rights = array_merge( $rights,
5036 // array_filter removes empty items
5037 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
5040 // now revoke the revoked permissions
5041 foreach ( $groups as $group ) {
5042 if ( isset( $wgRevokePermissions[$group] ) ) {
5043 $rights = array_diff( $rights,
5044 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
5047 return array_unique( $rights );
5051 * Get all the groups who have a given permission
5053 * @param string $role Role to check
5054 * @return array Array of Strings List of internal group names with the given permission
5056 public static function getGroupsWithPermission( $role ) {
5057 global $wgGroupPermissions;
5058 $allowedGroups = [];
5059 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
5060 if ( self
::groupHasPermission( $group, $role ) ) {
5061 $allowedGroups[] = $group;
5064 return $allowedGroups;
5068 * Check, if the given group has the given permission
5070 * If you're wanting to check whether all users have a permission, use
5071 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
5075 * @param string $group Group to check
5076 * @param string $role Role to check
5079 public static function groupHasPermission( $group, $role ) {
5080 global $wgGroupPermissions, $wgRevokePermissions;
5081 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
5082 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
5086 * Check if all users may be assumed to have the given permission
5088 * We generally assume so if the right is granted to '*' and isn't revoked
5089 * on any group. It doesn't attempt to take grants or other extension
5090 * limitations on rights into account in the general case, though, as that
5091 * would require it to always return false and defeat the purpose.
5092 * Specifically, session-based rights restrictions (such as OAuth or bot
5093 * passwords) are applied based on the current session.
5096 * @param string $right Right to check
5099 public static function isEveryoneAllowed( $right ) {
5100 global $wgGroupPermissions, $wgRevokePermissions;
5103 // Use the cached results, except in unit tests which rely on
5104 // being able change the permission mid-request
5105 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
5106 return $cache[$right];
5109 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
5110 $cache[$right] = false;
5114 // If it's revoked anywhere, then everyone doesn't have it
5115 foreach ( $wgRevokePermissions as $rights ) {
5116 if ( isset( $rights[$right] ) && $rights[$right] ) {
5117 $cache[$right] = false;
5122 // Remove any rights that aren't allowed to the global-session user,
5123 // unless there are no sessions for this endpoint.
5124 if ( !defined( 'MW_NO_SESSION' ) ) {
5125 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
5126 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
5127 $cache[$right] = false;
5132 // Allow extensions to say false
5133 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
5134 $cache[$right] = false;
5138 $cache[$right] = true;
5143 * Return the set of defined explicit groups.
5144 * The implicit groups (by default *, 'user' and 'autoconfirmed')
5145 * are not included, as they are defined automatically, not in the database.
5146 * @return array Array of internal group names
5148 public static function getAllGroups() {
5149 global $wgGroupPermissions, $wgRevokePermissions;
5150 return array_values( array_diff(
5151 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
5152 self
::getImplicitGroups()
5157 * Get a list of all available permissions.
5158 * @return string[] Array of permission names
5160 public static function getAllRights() {
5161 if ( self
::$mAllRights === false ) {
5162 global $wgAvailableRights;
5163 if ( count( $wgAvailableRights ) ) {
5164 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
5166 self
::$mAllRights = self
::$mCoreRights;
5168 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
5170 return self
::$mAllRights;
5174 * Get a list of implicit groups
5175 * TODO: Should we deprecate this? It's trivial, but we don't want to encourage use of globals.
5177 * @return array Array of Strings Array of internal group names
5179 public static function getImplicitGroups() {
5180 global $wgImplicitGroups;
5181 return $wgImplicitGroups;
5185 * Get the title of a page describing a particular group
5186 * @deprecated since 1.29 Use UserGroupMembership::getGroupPage instead
5188 * @param string $group Internal group name
5189 * @return Title|bool Title of the page if it exists, false otherwise
5191 public static function getGroupPage( $group ) {
5192 wfDeprecated( __METHOD__
, '1.29' );
5193 return UserGroupMembership
::getGroupPage( $group );
5197 * Create a link to the group in HTML, if available;
5198 * else return the group name.
5199 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5200 * make the link yourself if you need custom text
5202 * @param string $group Internal name of the group
5203 * @param string $text The text of the link
5204 * @return string HTML link to the group
5206 public static function makeGroupLinkHTML( $group, $text = '' ) {
5207 wfDeprecated( __METHOD__
, '1.29' );
5209 if ( $text == '' ) {
5210 $text = UserGroupMembership
::getGroupName( $group );
5212 $title = UserGroupMembership
::getGroupPage( $group );
5214 return MediaWikiServices
::getInstance()
5215 ->getLinkRenderer()->makeLink( $title, $text );
5218 return htmlspecialchars( $text );
5222 * Create a link to the group in Wikitext, if available;
5223 * else return the group name.
5224 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5225 * make the link yourself if you need custom text
5227 * @param string $group Internal name of the group
5228 * @param string $text The text of the link
5229 * @return string Wikilink to the group
5231 public static function makeGroupLinkWiki( $group, $text = '' ) {
5232 wfDeprecated( __METHOD__
, '1.29' );
5234 if ( $text == '' ) {
5235 $text = UserGroupMembership
::getGroupName( $group );
5237 $title = UserGroupMembership
::getGroupPage( $group );
5239 $page = $title->getFullText();
5240 return "[[$page|$text]]";
5247 * Returns an array of the groups that a particular group can add/remove.
5249 * @param string $group The group to check for whether it can add/remove
5250 * @return array Array( 'add' => array( addablegroups ),
5251 * 'remove' => array( removablegroups ),
5252 * 'add-self' => array( addablegroups to self),
5253 * 'remove-self' => array( removable groups from self) )
5255 public static function changeableByGroup( $group ) {
5256 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
5265 if ( empty( $wgAddGroups[$group] ) ) {
5266 // Don't add anything to $groups
5267 } elseif ( $wgAddGroups[$group] === true ) {
5268 // You get everything
5269 $groups['add'] = self
::getAllGroups();
5270 } elseif ( is_array( $wgAddGroups[$group] ) ) {
5271 $groups['add'] = $wgAddGroups[$group];
5274 // Same thing for remove
5275 if ( empty( $wgRemoveGroups[$group] ) ) {
5277 } elseif ( $wgRemoveGroups[$group] === true ) {
5278 $groups['remove'] = self
::getAllGroups();
5279 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
5280 $groups['remove'] = $wgRemoveGroups[$group];
5283 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
5284 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
5285 foreach ( $wgGroupsAddToSelf as $key => $value ) {
5286 if ( is_int( $key ) ) {
5287 $wgGroupsAddToSelf['user'][] = $value;
5292 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
5293 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
5294 if ( is_int( $key ) ) {
5295 $wgGroupsRemoveFromSelf['user'][] = $value;
5300 // Now figure out what groups the user can add to him/herself
5301 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
5303 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
5304 // No idea WHY this would be used, but it's there
5305 $groups['add-self'] = self
::getAllGroups();
5306 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
5307 $groups['add-self'] = $wgGroupsAddToSelf[$group];
5310 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
5312 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
5313 $groups['remove-self'] = self
::getAllGroups();
5314 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
5315 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
5322 * Returns an array of groups that this user can add and remove
5323 * @return array Array( 'add' => array( addablegroups ),
5324 * 'remove' => array( removablegroups ),
5325 * 'add-self' => array( addablegroups to self),
5326 * 'remove-self' => array( removable groups from self) )
5328 public function changeableGroups() {
5329 if ( $this->isAllowed( 'userrights' ) ) {
5330 // This group gives the right to modify everything (reverse-
5331 // compatibility with old "userrights lets you change
5333 // Using array_merge to make the groups reindexed
5334 $all = array_merge( self
::getAllGroups() );
5343 // Okay, it's not so simple, we will have to go through the arrays
5350 $addergroups = $this->getEffectiveGroups();
5352 foreach ( $addergroups as $addergroup ) {
5353 $groups = array_merge_recursive(
5354 $groups, $this->changeableByGroup( $addergroup )
5356 $groups['add'] = array_unique( $groups['add'] );
5357 $groups['remove'] = array_unique( $groups['remove'] );
5358 $groups['add-self'] = array_unique( $groups['add-self'] );
5359 $groups['remove-self'] = array_unique( $groups['remove-self'] );
5365 * Schedule a deferred update to update the user's edit count
5367 public function incEditCount() {
5368 if ( $this->isAnon() ) {
5372 DeferredUpdates
::addUpdate(
5373 new UserEditCountUpdate( $this, 1 ),
5374 DeferredUpdates
::POSTSEND
5379 * This method should not be called outside User/UserEditCountUpdate
5383 public function setEditCountInternal( $count ) {
5384 $this->mEditCount
= $count;
5388 * Initialize user_editcount from data out of the revision table
5390 * This method should not be called outside User/UserEditCountUpdate
5392 * @return int Number of edits
5394 public function initEditCountInternal() {
5395 // Pull from a replica DB to be less cruel to servers
5396 // Accuracy isn't the point anyway here
5397 $dbr = wfGetDB( DB_REPLICA
);
5398 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5399 $count = (int)$dbr->selectField(
5400 [ 'revision' ] +
$actorWhere['tables'],
5402 [ $actorWhere['conds'] ],
5405 $actorWhere['joins']
5408 $dbw = wfGetDB( DB_MASTER
);
5411 [ 'user_editcount' => $count ],
5413 'user_id' => $this->getId(),
5414 'user_editcount IS NULL OR user_editcount < ' . (int)$count
5423 * Get the description of a given right
5426 * @param string $right Right to query
5427 * @return string Localized description of the right
5429 public static function getRightDescription( $right ) {
5430 $key = "right-$right";
5431 $msg = wfMessage( $key );
5432 return $msg->isDisabled() ?
$right : $msg->text();
5436 * Get the name of a given grant
5439 * @param string $grant Grant to query
5440 * @return string Localized name of the grant
5442 public static function getGrantName( $grant ) {
5443 $key = "grant-$grant";
5444 $msg = wfMessage( $key );
5445 return $msg->isDisabled() ?
$grant : $msg->text();
5449 * Add a newuser log entry for this user.
5450 * Before 1.19 the return value was always true.
5452 * @deprecated since 1.27, AuthManager handles logging
5453 * @param string|bool $action Account creation type.
5454 * - String, one of the following values:
5455 * - 'create' for an anonymous user creating an account for himself.
5456 * This will force the action's performer to be the created user itself,
5457 * no matter the value of $wgUser
5458 * - 'create2' for a logged in user creating an account for someone else
5459 * - 'byemail' when the created user will receive its password by e-mail
5460 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5461 * - Boolean means whether the account was created by e-mail (deprecated):
5462 * - true will be converted to 'byemail'
5463 * - false will be converted to 'create' if this object is the same as
5464 * $wgUser and to 'create2' otherwise
5465 * @param string $reason User supplied reason
5468 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5469 return true; // disabled
5473 * Add an autocreate newuser log entry for this user
5474 * Used by things like CentralAuth and perhaps other authplugins.
5475 * Consider calling addNewUserLogEntry() directly instead.
5477 * @deprecated since 1.27, AuthManager handles logging
5480 public function addNewUserLogEntryAutoCreate() {
5481 $this->addNewUserLogEntry( 'autocreate' );
5487 * Load the user options either from cache, the database or an array
5489 * @param array|null $data Rows for the current user out of the user_properties table
5491 protected function loadOptions( $data = null ) {
5494 if ( $this->mOptionsLoaded
) {
5498 $this->mOptions
= self
::getDefaultOptions();
5500 if ( !$this->getId() ) {
5501 // For unlogged-in users, load language/variant options from request.
5502 // There's no need to do it for logged-in users: they can set preferences,
5503 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5504 // so don't override user's choice (especially when the user chooses site default).
5505 $variant = MediaWikiServices
::getInstance()->getContentLanguage()->getDefaultVariant();
5506 $this->mOptions
['variant'] = $variant;
5507 $this->mOptions
['language'] = $variant;
5508 $this->mOptionsLoaded
= true;
5512 // Maybe load from the object
5513 if ( !is_null( $this->mOptionOverrides
) ) {
5514 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5515 foreach ( $this->mOptionOverrides
as $key => $value ) {
5516 $this->mOptions
[$key] = $value;
5519 if ( !is_array( $data ) ) {
5520 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5521 // Load from database
5522 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5523 ?
wfGetDB( DB_MASTER
)
5524 : wfGetDB( DB_REPLICA
);
5526 $res = $dbr->select(
5528 [ 'up_property', 'up_value' ],
5529 [ 'up_user' => $this->getId() ],
5533 $this->mOptionOverrides
= [];
5535 foreach ( $res as $row ) {
5536 // Convert '0' to 0. PHP's boolean conversion considers them both
5537 // false, but e.g. JavaScript considers the former as true.
5538 // @todo: T54542 Somehow determine the desired type (string/int/bool)
5539 // and convert all values here.
5540 if ( $row->up_value
=== '0' ) {
5543 $data[$row->up_property
] = $row->up_value
;
5547 foreach ( $data as $property => $value ) {
5548 $this->mOptionOverrides
[$property] = $value;
5549 $this->mOptions
[$property] = $value;
5553 // Replace deprecated language codes
5554 $this->mOptions
['language'] = LanguageCode
::replaceDeprecatedCodes(
5555 $this->mOptions
['language']
5558 $this->mOptionsLoaded
= true;
5560 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5564 * Saves the non-default options for this user, as previously set e.g. via
5565 * setOption(), in the database's "user_properties" (preferences) table.
5566 * Usually used via saveSettings().
5568 protected function saveOptions() {
5569 $this->loadOptions();
5571 // Not using getOptions(), to keep hidden preferences in database
5572 $saveOptions = $this->mOptions
;
5574 // Allow hooks to abort, for instance to save to a global profile.
5575 // Reset options to default state before saving.
5576 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5580 $userId = $this->getId();
5582 $insert_rows = []; // all the new preference rows
5583 foreach ( $saveOptions as $key => $value ) {
5584 // Don't bother storing default values
5585 $defaultOption = self
::getDefaultOption( $key );
5586 if ( ( $defaultOption === null && $value !== false && $value !== null )
5587 ||
$value != $defaultOption
5590 'up_user' => $userId,
5591 'up_property' => $key,
5592 'up_value' => $value,
5597 $dbw = wfGetDB( DB_MASTER
);
5599 $res = $dbw->select( 'user_properties',
5600 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5602 // Find prior rows that need to be removed or updated. These rows will
5603 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5605 foreach ( $res as $row ) {
5606 if ( !isset( $saveOptions[$row->up_property
] )
5607 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5609 $keysDelete[] = $row->up_property
;
5613 if ( count( $keysDelete ) ) {
5614 // Do the DELETE by PRIMARY KEY for prior rows.
5615 // In the past a very large portion of calls to this function are for setting
5616 // 'rememberpassword' for new accounts (a preference that has since been removed).
5617 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5618 // caused gap locks on [max user ID,+infinity) which caused high contention since
5619 // updates would pile up on each other as they are for higher (newer) user IDs.
5620 // It might not be necessary these days, but it shouldn't hurt either.
5621 $dbw->delete( 'user_properties',
5622 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5624 // Insert the new preference rows
5625 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5629 * Return the list of user fields that should be selected to create
5630 * a new user object.
5631 * @deprecated since 1.31, use self::getQueryInfo() instead.
5634 public static function selectFields() {
5635 wfDeprecated( __METHOD__
, '1.31' );
5643 'user_email_authenticated',
5645 'user_email_token_expires',
5646 'user_registration',
5652 * Return the tables, fields, and join conditions to be selected to create
5653 * a new user object.
5655 * @return array With three keys:
5656 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
5657 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
5658 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
5660 public static function getQueryInfo() {
5661 global $wgActorTableSchemaMigrationStage;
5664 'tables' => [ 'user' ],
5672 'user_email_authenticated',
5674 'user_email_token_expires',
5675 'user_registration',
5681 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
5682 // but it does little harm and might be needed for write callers loading a User.
5683 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
5684 $ret['tables']['user_actor'] = 'actor';
5685 $ret['fields'][] = 'user_actor.actor_id';
5686 $ret['joins']['user_actor'] = [
5687 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) ?
'JOIN' : 'LEFT JOIN',
5688 [ 'user_actor.actor_user = user_id' ]
5696 * Factory function for fatal permission-denied errors
5699 * @param string $permission User right required
5702 static function newFatalPermissionDeniedStatus( $permission ) {
5706 foreach ( self
::getGroupsWithPermission( $permission ) as $group ) {
5707 $groups[] = UserGroupMembership
::getLink( $group, RequestContext
::getMain(), 'wiki' );
5711 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5714 return Status
::newFatal( 'badaccess-group0' );
5718 * Get a new instance of this user that was loaded from the master via a locking read
5720 * Use this instead of the main context User when updating that user. This avoids races
5721 * where that user was loaded from a replica DB or even the master but without proper locks.
5723 * @return User|null Returns null if the user was not found in the DB
5726 public function getInstanceForUpdate() {
5727 if ( !$this->getId() ) {
5728 return null; // anon
5731 $user = self
::newFromId( $this->getId() );
5732 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5740 * Checks if two user objects point to the same user.
5742 * @since 1.25 ; takes a UserIdentity instead of a User since 1.32
5743 * @param UserIdentity $user
5746 public function equals( UserIdentity
$user ) {
5747 // XXX it's not clear whether central ID providers are supposed to obey this
5748 return $this->getName() === $user->getName();