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 // Reject various classes of invalid names
1264 $name = AuthManager
::callLegacyAuthPlugin(
1265 'getCanonicalName', [ $t->getText() ], $t->getText()
1268 switch ( $validate ) {
1272 if ( !self
::isValidUserName( $name ) ) {
1277 if ( !self
::isUsableName( $name ) ) {
1282 if ( !self
::isCreatableName( $name ) ) {
1287 throw new InvalidArgumentException(
1288 'Invalid parameter value for $validate in ' . __METHOD__
);
1294 * Return a random password.
1296 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1297 * @return string New random password
1299 public static function randomPassword() {
1300 global $wgMinimalPasswordLength;
1301 return PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1305 * Set cached properties to default.
1307 * @note This no longer clears uncached lazy-initialised properties;
1308 * the constructor does that instead.
1310 * @param string|bool $name
1312 public function loadDefaults( $name = false ) {
1314 $this->mName
= $name;
1315 $this->mActorId
= null;
1316 $this->mRealName
= '';
1318 $this->mOptionOverrides
= null;
1319 $this->mOptionsLoaded
= false;
1321 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1322 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1323 if ( $loggedOut !== 0 ) {
1324 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1326 $this->mTouched
= '1'; # Allow any pages to be cached
1329 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1330 $this->mEmailAuthenticated
= null;
1331 $this->mEmailToken
= '';
1332 $this->mEmailTokenExpires
= null;
1333 $this->mRegistration
= wfTimestamp( TS_MW
);
1334 $this->mGroupMemberships
= [];
1336 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1340 * Return whether an item has been loaded.
1342 * @param string $item Item to check. Current possibilities:
1346 * @param string $all 'all' to check if the whole object has been loaded
1347 * or any other string to check if only the item is available (e.g.
1351 public function isItemLoaded( $item, $all = 'all' ) {
1352 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1353 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1357 * Set that an item has been loaded
1359 * @param string $item
1361 protected function setItemLoaded( $item ) {
1362 if ( is_array( $this->mLoadedItems
) ) {
1363 $this->mLoadedItems
[$item] = true;
1368 * Load user data from the session.
1370 * @return bool True if the user is logged in, false otherwise.
1372 private function loadFromSession() {
1375 Hooks
::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1376 if ( $result !== null ) {
1380 // MediaWiki\Session\Session already did the necessary authentication of the user
1381 // returned here, so just use it if applicable.
1382 $session = $this->getRequest()->getSession();
1383 $user = $session->getUser();
1384 if ( $user->isLoggedIn() ) {
1385 $this->loadFromUserObject( $user );
1386 if ( $user->isBlocked() ) {
1387 // If this user is autoblocked, set a cookie to track the Block. This has to be done on
1388 // every session load, because an autoblocked editor might not edit again from the same
1389 // IP address after being blocked.
1390 $this->trackBlockWithCookie();
1393 // Other code expects these to be set in the session, so set them.
1394 $session->set( 'wsUserID', $this->getId() );
1395 $session->set( 'wsUserName', $this->getName() );
1396 $session->set( 'wsToken', $this->getToken() );
1405 * Set the 'BlockID' cookie depending on block type and user authentication status.
1407 public function trackBlockWithCookie() {
1408 $block = $this->getBlock();
1409 if ( $block && $this->getRequest()->getCookie( 'BlockID' ) === null ) {
1410 $config = RequestContext
::getMain()->getConfig();
1411 $shouldSetCookie = false;
1413 if ( $this->isAnon() && $config->get( 'CookieSetOnIpBlock' ) ) {
1414 // If user is logged-out, set a cookie to track the Block
1415 $shouldSetCookie = in_array( $block->getType(), [
1416 Block
::TYPE_IP
, Block
::TYPE_RANGE
1418 if ( $shouldSetCookie ) {
1419 $block->setCookie( $this->getRequest()->response() );
1421 // temporary measure the use of cookies on ip blocks
1422 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1423 $stats->increment( 'block.ipblock.setCookie.success' );
1425 } elseif ( $this->isLoggedIn() && $config->get( 'CookieSetOnAutoblock' ) ) {
1426 $shouldSetCookie = $block->getType() === Block
::TYPE_USER
&& $block->isAutoblocking();
1427 if ( $shouldSetCookie ) {
1428 $block->setCookie( $this->getRequest()->response() );
1435 * Load user and user_group data from the database.
1436 * $this->mId must be set, this is how the user is identified.
1438 * @param int $flags User::READ_* constant bitfield
1439 * @return bool True if the user exists, false if the user is anonymous
1441 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1443 $this->mId
= intval( $this->mId
);
1445 if ( !$this->mId
) {
1446 // Anonymous users are not in the database
1447 $this->loadDefaults();
1451 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1452 $db = wfGetDB( $index );
1454 $userQuery = self
::getQueryInfo();
1455 $s = $db->selectRow(
1456 $userQuery['tables'],
1457 $userQuery['fields'],
1458 [ 'user_id' => $this->mId
],
1464 $this->queryFlagsUsed
= $flags;
1465 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1467 if ( $s !== false ) {
1468 // Initialise user table data
1469 $this->loadFromRow( $s );
1470 $this->mGroupMemberships
= null; // deferred
1471 $this->getEditCount(); // revalidation for nulls
1477 $this->loadDefaults();
1483 * Initialize this object from a row from the user table.
1485 * @param stdClass $row Row from the user table to load.
1486 * @param array|null $data Further user data to load into the object
1488 * user_groups Array of arrays or stdClass result rows out of the user_groups
1489 * table. Previously you were supposed to pass an array of strings
1490 * here, but we also need expiry info nowadays, so an array of
1491 * strings is ignored.
1492 * user_properties Array with properties out of the user_properties table
1494 protected function loadFromRow( $row, $data = null ) {
1495 global $wgActorTableSchemaMigrationStage;
1497 if ( !is_object( $row ) ) {
1498 throw new InvalidArgumentException( '$row must be an object' );
1503 $this->mGroupMemberships
= null; // deferred
1505 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
1506 // but it does little harm and might be needed for write callers loading a User.
1507 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
1508 if ( isset( $row->actor_id
) ) {
1509 $this->mActorId
= (int)$row->actor_id
;
1510 if ( $this->mActorId
!== 0 ) {
1511 $this->mFrom
= 'actor';
1513 $this->setItemLoaded( 'actor' );
1519 if ( isset( $row->user_name
) && $row->user_name
!== '' ) {
1520 $this->mName
= $row->user_name
;
1521 $this->mFrom
= 'name';
1522 $this->setItemLoaded( 'name' );
1527 if ( isset( $row->user_real_name
) ) {
1528 $this->mRealName
= $row->user_real_name
;
1529 $this->setItemLoaded( 'realname' );
1534 if ( isset( $row->user_id
) ) {
1535 $this->mId
= intval( $row->user_id
);
1536 if ( $this->mId
!== 0 ) {
1537 $this->mFrom
= 'id';
1539 $this->setItemLoaded( 'id' );
1544 if ( isset( $row->user_id
) && isset( $row->user_name
) && $row->user_name
!== '' ) {
1545 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1548 if ( isset( $row->user_editcount
) ) {
1549 $this->mEditCount
= $row->user_editcount
;
1554 if ( isset( $row->user_touched
) ) {
1555 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1560 if ( isset( $row->user_token
) ) {
1561 // The definition for the column is binary(32), so trim the NULs
1562 // that appends. The previous definition was char(32), so trim
1564 $this->mToken
= rtrim( $row->user_token
, " \0" );
1565 if ( $this->mToken
=== '' ) {
1566 $this->mToken
= null;
1572 if ( isset( $row->user_email
) ) {
1573 $this->mEmail
= $row->user_email
;
1574 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1575 $this->mEmailToken
= $row->user_email_token
;
1576 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1577 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1583 $this->mLoadedItems
= true;
1586 if ( is_array( $data ) ) {
1587 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1588 if ( $data['user_groups'] === [] ) {
1589 $this->mGroupMemberships
= [];
1591 $firstGroup = reset( $data['user_groups'] );
1592 if ( is_array( $firstGroup ) ||
is_object( $firstGroup ) ) {
1593 $this->mGroupMemberships
= [];
1594 foreach ( $data['user_groups'] as $row ) {
1595 $ugm = UserGroupMembership
::newFromRow( (object)$row );
1596 $this->mGroupMemberships
[$ugm->getGroup()] = $ugm;
1601 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1602 $this->loadOptions( $data['user_properties'] );
1608 * Load the data for this user object from another user object.
1612 protected function loadFromUserObject( $user ) {
1614 foreach ( self
::$mCacheVars as $var ) {
1615 $this->$var = $user->$var;
1620 * Load the groups from the database if they aren't already loaded.
1622 private function loadGroups() {
1623 if ( is_null( $this->mGroupMemberships
) ) {
1624 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1625 ?
wfGetDB( DB_MASTER
)
1626 : wfGetDB( DB_REPLICA
);
1627 $this->mGroupMemberships
= UserGroupMembership
::getMembershipsForUser(
1633 * Add the user to the group if he/she meets given criteria.
1635 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1636 * possible to remove manually via Special:UserRights. In such case it
1637 * will not be re-added automatically. The user will also not lose the
1638 * group if they no longer meet the criteria.
1640 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1642 * @return array Array of groups the user has been promoted to.
1644 * @see $wgAutopromoteOnce
1646 public function addAutopromoteOnceGroups( $event ) {
1647 global $wgAutopromoteOnceLogInRC;
1649 if ( wfReadOnly() ||
!$this->getId() ) {
1653 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1654 if ( $toPromote === [] ) {
1658 if ( !$this->checkAndSetTouched() ) {
1659 return []; // raced out (bug T48834)
1662 $oldGroups = $this->getGroups(); // previous groups
1663 $oldUGMs = $this->getGroupMemberships();
1664 foreach ( $toPromote as $group ) {
1665 $this->addGroup( $group );
1667 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1668 $newUGMs = $this->getGroupMemberships();
1670 // update groups in external authentication database
1671 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );
1672 AuthManager
::callLegacyAuthPlugin( 'updateExternalDBGroups', [ $this, $toPromote ] );
1674 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1675 $logEntry->setPerformer( $this );
1676 $logEntry->setTarget( $this->getUserPage() );
1677 $logEntry->setParameters( [
1678 '4::oldgroups' => $oldGroups,
1679 '5::newgroups' => $newGroups,
1681 $logid = $logEntry->insert();
1682 if ( $wgAutopromoteOnceLogInRC ) {
1683 $logEntry->publish( $logid );
1690 * Builds update conditions. Additional conditions may be added to $conditions to
1691 * protected against race conditions using a compare-and-set (CAS) mechanism
1692 * based on comparing $this->mTouched with the user_touched field.
1694 * @param Database $db
1695 * @param array $conditions WHERE conditions for use with Database::update
1696 * @return array WHERE conditions for use with Database::update
1698 protected function makeUpdateConditions( Database
$db, array $conditions ) {
1699 if ( $this->mTouched
) {
1700 // CAS check: only update if the row wasn't changed sicne it was loaded.
1701 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1708 * Bump user_touched if it didn't change since this object was loaded
1710 * On success, the mTouched field is updated.
1711 * The user serialization cache is always cleared.
1713 * @return bool Whether user_touched was actually updated
1716 protected function checkAndSetTouched() {
1719 if ( !$this->mId
) {
1720 return false; // anon
1723 // Get a new user_touched that is higher than the old one
1724 $newTouched = $this->newTouchedTimestamp();
1726 $dbw = wfGetDB( DB_MASTER
);
1727 $dbw->update( 'user',
1728 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1729 $this->makeUpdateConditions( $dbw, [
1730 'user_id' => $this->mId
,
1734 $success = ( $dbw->affectedRows() > 0 );
1737 $this->mTouched
= $newTouched;
1738 $this->clearSharedCache();
1740 // Clears on failure too since that is desired if the cache is stale
1741 $this->clearSharedCache( 'refresh' );
1748 * Clear various cached data stored in this object. The cache of the user table
1749 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1751 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1752 * given source. May be "name", "id", "actor", "defaults", "session", or false for no reload.
1754 public function clearInstanceCache( $reloadFrom = false ) {
1755 $this->mNewtalk
= -1;
1756 $this->mDatePreference
= null;
1757 $this->mBlockedby
= -1; # Unset
1758 $this->mHash
= false;
1759 $this->mRights
= null;
1760 $this->mEffectiveGroups
= null;
1761 $this->mImplicitGroups
= null;
1762 $this->mGroupMemberships
= null;
1763 $this->mOptions
= null;
1764 $this->mOptionsLoaded
= false;
1765 $this->mEditCount
= null;
1767 if ( $reloadFrom ) {
1768 $this->mLoadedItems
= [];
1769 $this->mFrom
= $reloadFrom;
1774 * Combine the language default options with any site-specific options
1775 * and add the default language variants.
1777 * @return array Array of String options
1779 public static function getDefaultOptions() {
1780 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgDefaultSkin;
1782 static $defOpt = null;
1783 static $defOptLang = null;
1785 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
1786 if ( $defOpt !== null && $defOptLang === $contLang->getCode() ) {
1787 // The content language does not change (and should not change) mid-request, but the
1788 // unit tests change it anyway, and expect this method to return values relevant to the
1789 // current content language.
1793 $defOpt = $wgDefaultUserOptions;
1794 // Default language setting
1795 $defOptLang = $contLang->getCode();
1796 $defOpt['language'] = $defOptLang;
1797 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1798 if ( $langCode === $contLang->getCode() ) {
1799 $defOpt['variant'] = $langCode;
1801 $defOpt["variant-$langCode"] = $langCode;
1805 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1806 // since extensions may change the set of searchable namespaces depending
1807 // on user groups/permissions.
1808 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1809 $defOpt['searchNs' . $nsnum] = (bool)$val;
1811 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1813 Hooks
::run( 'UserGetDefaultOptions', [ &$defOpt ] );
1819 * Get a given default option value.
1821 * @param string $opt Name of option to retrieve
1822 * @return string Default option value
1824 public static function getDefaultOption( $opt ) {
1825 $defOpts = self
::getDefaultOptions();
1826 return $defOpts[$opt] ??
null;
1830 * Get blocking information
1831 * @param bool $bFromReplica Whether to check the replica DB first.
1832 * To improve performance, non-critical checks are done against replica DBs.
1833 * Check when actually saving should be done against master.
1835 private function getBlockedStatus( $bFromReplica = true ) {
1836 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff, $wgSoftBlockRanges;
1838 if ( $this->mBlockedby
!= -1 ) {
1842 wfDebug( __METHOD__
. ": checking...\n" );
1844 // Initialize data...
1845 // Otherwise something ends up stomping on $this->mBlockedby when
1846 // things get lazy-loaded later, causing false positive block hits
1847 // due to -1 !== 0. Probably session-related... Nothing should be
1848 // overwriting mBlockedby, surely?
1851 # We only need to worry about passing the IP address to the Block generator if the
1852 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1853 # know which IP address they're actually coming from
1855 if ( !$this->isAllowed( 'ipblock-exempt' ) ) {
1856 // $wgUser->getName() only works after the end of Setup.php. Until
1857 // then, assume it's a logged-out user.
1858 $globalUserName = $wgUser->isSafeToLoad()
1859 ?
$wgUser->getName()
1860 : IP
::sanitizeIP( $wgUser->getRequest()->getIP() );
1861 if ( $this->getName() === $globalUserName ) {
1862 $ip = $this->getRequest()->getIP();
1867 $block = Block
::newFromTarget( $this, $ip, !$bFromReplica );
1870 if ( !$block instanceof Block
) {
1871 $block = $this->getBlockFromCookieValue( $this->getRequest()->getCookie( 'BlockID' ) );
1875 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1877 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1878 $block = new Block( [
1879 'byText' => wfMessage( 'proxyblocker' )->text(),
1880 'reason' => wfMessage( 'proxyblockreason' )->plain(),
1882 'systemBlock' => 'proxy',
1884 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1885 $block = new Block( [
1886 'byText' => wfMessage( 'sorbs' )->text(),
1887 'reason' => wfMessage( 'sorbsreason' )->plain(),
1889 'systemBlock' => 'dnsbl',
1894 // (T25343) Apply IP blocks to the contents of XFF headers, if enabled
1895 if ( !$block instanceof Block
1896 && $wgApplyIpBlocksToXff
1898 && !in_array( $ip, $wgProxyWhitelist )
1900 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1901 $xff = array_map( 'trim', explode( ',', $xff ) );
1902 $xff = array_diff( $xff, [ $ip ] );
1903 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromReplica );
1904 $block = Block
::chooseBlock( $xffblocks, $xff );
1905 if ( $block instanceof Block
) {
1906 # Mangle the reason to alert the user that the block
1907 # originated from matching the X-Forwarded-For header.
1908 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->plain();
1912 if ( !$block instanceof Block
1915 && IP
::isInRanges( $ip, $wgSoftBlockRanges )
1917 $block = new Block( [
1919 'byText' => 'MediaWiki default',
1920 'reason' => wfMessage( 'softblockrangesreason', $ip )->plain(),
1922 'systemBlock' => 'wgSoftBlockRanges',
1926 if ( $block instanceof Block
) {
1927 wfDebug( __METHOD__
. ": Found block.\n" );
1928 $this->mBlock
= $block;
1929 $this->mBlockedby
= $block->getByName();
1930 $this->mBlockreason
= $block->mReason
;
1931 $this->mHideName
= $block->mHideName
;
1932 $this->mAllowUsertalk
= $block->isUsertalkEditAllowed();
1934 $this->mBlock
= null;
1935 $this->mBlockedby
= '';
1936 $this->mBlockreason
= '';
1937 $this->mHideName
= 0;
1938 $this->mAllowUsertalk
= false;
1941 // Avoid PHP 7.1 warning of passing $this by reference
1944 Hooks
::run( 'GetBlockedStatus', [ &$user ] );
1948 * Try to load a Block from an ID given in a cookie value.
1949 * @param string|null $blockCookieVal The cookie value to check.
1950 * @return Block|bool The Block object, or false if none could be loaded.
1952 protected function getBlockFromCookieValue( $blockCookieVal ) {
1953 // Make sure there's something to check. The cookie value must start with a number.
1954 if ( strlen( $blockCookieVal ) < 1 ||
!is_numeric( substr( $blockCookieVal, 0, 1 ) ) ) {
1957 // Load the Block from the ID in the cookie.
1958 $blockCookieId = Block
::getIdFromCookieValue( $blockCookieVal );
1959 if ( $blockCookieId !== null ) {
1960 // An ID was found in the cookie.
1961 $tmpBlock = Block
::newFromID( $blockCookieId );
1962 if ( $tmpBlock instanceof Block
) {
1963 $config = RequestContext
::getMain()->getConfig();
1965 switch ( $tmpBlock->getType() ) {
1966 case Block
::TYPE_USER
:
1967 $blockIsValid = !$tmpBlock->isExpired() && $tmpBlock->isAutoblocking();
1968 $useBlockCookie = ( $config->get( 'CookieSetOnAutoblock' ) === true );
1970 case Block
::TYPE_IP
:
1971 case Block
::TYPE_RANGE
:
1972 // If block is type IP or IP range, load only if user is not logged in (T152462)
1973 $blockIsValid = !$tmpBlock->isExpired() && !$this->isLoggedIn();
1974 $useBlockCookie = ( $config->get( 'CookieSetOnIpBlock' ) === true );
1977 $blockIsValid = false;
1978 $useBlockCookie = false;
1981 if ( $blockIsValid && $useBlockCookie ) {
1986 // If the block is not valid, remove the cookie.
1987 Block
::clearCookie( $this->getRequest()->response() );
1989 // If the block doesn't exist, remove the cookie.
1990 Block
::clearCookie( $this->getRequest()->response() );
1997 * Whether the given IP is in a DNS blacklist.
1999 * @param string $ip IP to check
2000 * @param bool $checkWhitelist Whether to check the whitelist first
2001 * @return bool True if blacklisted.
2003 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
2004 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
2006 if ( !$wgEnableDnsBlacklist ||
2007 ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
2012 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
2016 * Whether the given IP is in a given DNS blacklist.
2018 * @param string $ip IP to check
2019 * @param string|array $bases Array of Strings: URL of the DNS blacklist
2020 * @return bool True if blacklisted.
2022 public function inDnsBlacklist( $ip, $bases ) {
2024 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
2025 if ( IP
::isIPv4( $ip ) ) {
2026 // Reverse IP, T23255
2027 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
2029 foreach ( (array)$bases as $base ) {
2031 // If we have an access key, use that too (ProjectHoneypot, etc.)
2033 if ( is_array( $base ) ) {
2034 if ( count( $base ) >= 2 ) {
2035 // Access key is 1, base URL is 0
2036 $host = "{$base[1]}.$ipReversed.{$base[0]}";
2038 $host = "$ipReversed.{$base[0]}";
2040 $basename = $base[0];
2042 $host = "$ipReversed.$base";
2046 $ipList = gethostbynamel( $host );
2049 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
2054 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
2062 * Check if an IP address is in the local proxy list
2068 public static function isLocallyBlockedProxy( $ip ) {
2069 global $wgProxyList;
2071 if ( !$wgProxyList ) {
2075 if ( !is_array( $wgProxyList ) ) {
2076 // Load values from the specified file
2077 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
2080 $resultProxyList = [];
2081 $deprecatedIPEntries = [];
2083 // backward compatibility: move all ip addresses in keys to values
2084 foreach ( $wgProxyList as $key => $value ) {
2085 $keyIsIP = IP
::isIPAddress( $key );
2086 $valueIsIP = IP
::isIPAddress( $value );
2087 if ( $keyIsIP && !$valueIsIP ) {
2088 $deprecatedIPEntries[] = $key;
2089 $resultProxyList[] = $key;
2090 } elseif ( $keyIsIP && $valueIsIP ) {
2091 $deprecatedIPEntries[] = $key;
2092 $resultProxyList[] = $key;
2093 $resultProxyList[] = $value;
2095 $resultProxyList[] = $value;
2099 if ( $deprecatedIPEntries ) {
2101 'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
2102 implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
2105 $proxyListIPSet = new IPSet( $resultProxyList );
2106 return $proxyListIPSet->match( $ip );
2110 * Is this user subject to rate limiting?
2112 * @return bool True if rate limited
2114 public function isPingLimitable() {
2115 global $wgRateLimitsExcludedIPs;
2116 if ( IP
::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
2117 // No other good way currently to disable rate limits
2118 // for specific IPs. :P
2119 // But this is a crappy hack and should die.
2122 return !$this->isAllowed( 'noratelimit' );
2126 * Primitive rate limits: enforce maximum actions per time period
2127 * to put a brake on flooding.
2129 * The method generates both a generic profiling point and a per action one
2130 * (suffix being "-$action".
2132 * @note When using a shared cache like memcached, IP-address
2133 * last-hit counters will be shared across wikis.
2135 * @param string $action Action to enforce; 'edit' if unspecified
2136 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
2137 * @return bool True if a rate limiter was tripped
2139 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
2140 // Avoid PHP 7.1 warning of passing $this by reference
2142 // Call the 'PingLimiter' hook
2144 if ( !Hooks
::run( 'PingLimiter', [ &$user, $action, &$result, $incrBy ] ) ) {
2148 global $wgRateLimits;
2149 if ( !isset( $wgRateLimits[$action] ) ) {
2153 $limits = array_merge(
2154 [ '&can-bypass' => true ],
2155 $wgRateLimits[$action]
2158 // Some groups shouldn't trigger the ping limiter, ever
2159 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
2164 $id = $this->getId();
2166 $isNewbie = $this->isNewbie();
2167 $cache = ObjectCache
::getLocalClusterInstance();
2171 if ( isset( $limits['anon'] ) ) {
2172 $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
2174 } elseif ( isset( $limits['user'] ) ) {
2175 // limits for logged-in users
2176 $userLimit = $limits['user'];
2179 // limits for anons and for newbie logged-in users
2182 if ( isset( $limits['ip'] ) ) {
2183 $ip = $this->getRequest()->getIP();
2184 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
2186 // subnet-based limits
2187 if ( isset( $limits['subnet'] ) ) {
2188 $ip = $this->getRequest()->getIP();
2189 $subnet = IP
::getSubnet( $ip );
2190 if ( $subnet !== false ) {
2191 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
2196 // Check for group-specific permissions
2197 // If more than one group applies, use the group with the highest limit ratio (max/period)
2198 foreach ( $this->getGroups() as $group ) {
2199 if ( isset( $limits[$group] ) ) {
2200 if ( $userLimit === false
2201 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
2203 $userLimit = $limits[$group];
2208 // limits for newbie logged-in users (override all the normal user limits)
2209 if ( $id !== 0 && $isNewbie && isset( $limits['newbie'] ) ) {
2210 $userLimit = $limits['newbie'];
2213 // Set the user limit key
2214 if ( $userLimit !== false ) {
2215 list( $max, $period ) = $userLimit;
2216 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
2217 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
2220 // ip-based limits for all ping-limitable users
2221 if ( isset( $limits['ip-all'] ) ) {
2222 $ip = $this->getRequest()->getIP();
2223 // ignore if user limit is more permissive
2224 if ( $isNewbie ||
$userLimit === false
2225 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
2226 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
2230 // subnet-based limits for all ping-limitable users
2231 if ( isset( $limits['subnet-all'] ) ) {
2232 $ip = $this->getRequest()->getIP();
2233 $subnet = IP
::getSubnet( $ip );
2234 if ( $subnet !== false ) {
2235 // ignore if user limit is more permissive
2236 if ( $isNewbie ||
$userLimit === false
2237 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
2238 > $userLimit[0] / $userLimit[1] ) {
2239 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
2245 foreach ( $keys as $key => $limit ) {
2246 list( $max, $period ) = $limit;
2247 $summary = "(limit $max in {$period}s)";
2248 $count = $cache->get( $key );
2251 if ( $count >= $max ) {
2252 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
2253 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
2256 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
2259 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
2260 if ( $incrBy > 0 ) {
2261 $cache->add( $key, 0, intval( $period ) ); // first ping
2264 if ( $incrBy > 0 ) {
2265 $cache->incr( $key, $incrBy );
2273 * Check if user is blocked
2275 * @param bool $bFromReplica Whether to check the replica DB instead of
2276 * the master. Hacked from false due to horrible probs on site.
2277 * @return bool True if blocked, false otherwise
2279 public function isBlocked( $bFromReplica = true ) {
2280 return $this->getBlock( $bFromReplica ) instanceof Block
&&
2281 $this->getBlock()->appliesToRight( 'edit' );
2285 * Get the block affecting the user, or null if the user is not blocked
2287 * @param bool $bFromReplica Whether to check the replica DB instead of the master
2288 * @return Block|null
2290 public function getBlock( $bFromReplica = true ) {
2291 $this->getBlockedStatus( $bFromReplica );
2292 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
2296 * Check if user is blocked from editing a particular article
2298 * @param Title $title Title to check
2299 * @param bool $fromReplica Whether to check the replica DB instead of the master
2302 public function isBlockedFrom( $title, $fromReplica = false ) {
2303 $blocked = $this->isHidden();
2306 $block = $this->getBlock( $fromReplica );
2308 // Special handling for a user's own talk page. The block is not aware
2309 // of the user, so this must be done here.
2310 if ( $title->equals( $this->getTalkPage() ) ) {
2311 $blocked = $block->appliesToUsertalk( $title );
2313 $blocked = $block->appliesToTitle( $title );
2318 // only for the purpose of the hook. We really don't need this here.
2319 $allowUsertalk = $this->mAllowUsertalk
;
2321 Hooks
::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
2327 * If user is blocked, return the name of the user who placed the block
2328 * @return string Name of blocker
2330 public function blockedBy() {
2331 $this->getBlockedStatus();
2332 return $this->mBlockedby
;
2336 * If user is blocked, return the specified reason for the block
2337 * @return string Blocking reason
2339 public function blockedFor() {
2340 $this->getBlockedStatus();
2341 return $this->mBlockreason
;
2345 * If user is blocked, return the ID for the block
2346 * @return int Block ID
2348 public function getBlockId() {
2349 $this->getBlockedStatus();
2350 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2354 * Check if user is blocked on all wikis.
2355 * Do not use for actual edit permission checks!
2356 * This is intended for quick UI checks.
2358 * @param string $ip IP address, uses current client if none given
2359 * @return bool True if blocked, false otherwise
2361 public function isBlockedGlobally( $ip = '' ) {
2362 return $this->getGlobalBlock( $ip ) instanceof Block
;
2366 * Check if user is blocked on all wikis.
2367 * Do not use for actual edit permission checks!
2368 * This is intended for quick UI checks.
2370 * @param string $ip IP address, uses current client if none given
2371 * @return Block|null Block object if blocked, null otherwise
2372 * @throws FatalError
2373 * @throws MWException
2375 public function getGlobalBlock( $ip = '' ) {
2376 if ( $this->mGlobalBlock
!== null ) {
2377 return $this->mGlobalBlock ?
: null;
2379 // User is already an IP?
2380 if ( IP
::isIPAddress( $this->getName() ) ) {
2381 $ip = $this->getName();
2383 $ip = $this->getRequest()->getIP();
2385 // Avoid PHP 7.1 warning of passing $this by reference
2389 Hooks
::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
2391 if ( $blocked && $block === null ) {
2392 // back-compat: UserIsBlockedGlobally didn't have $block param first
2393 $block = new Block( [
2395 'systemBlock' => 'global-block'
2399 $this->mGlobalBlock
= $blocked ?
$block : false;
2400 return $this->mGlobalBlock ?
: null;
2404 * Check if user account is locked
2406 * @return bool True if locked, false otherwise
2408 public function isLocked() {
2409 if ( $this->mLocked
!== null ) {
2410 return $this->mLocked
;
2412 // Avoid PHP 7.1 warning of passing $this by reference
2414 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$user ], null );
2415 $this->mLocked
= $authUser && $authUser->isLocked();
2416 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2417 return $this->mLocked
;
2421 * Check if user account is hidden
2423 * @return bool True if hidden, false otherwise
2425 public function isHidden() {
2426 if ( $this->mHideName
!== null ) {
2427 return (bool)$this->mHideName
;
2429 $this->getBlockedStatus();
2430 if ( !$this->mHideName
) {
2431 // Avoid PHP 7.1 warning of passing $this by reference
2433 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$user ], null );
2434 $this->mHideName
= $authUser && $authUser->isHidden();
2435 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2437 return (bool)$this->mHideName
;
2441 * Get the user's ID.
2442 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2444 public function getId() {
2445 if ( $this->mId
=== null && $this->mName
!== null && self
::isIP( $this->mName
) ) {
2446 // Special case, we know the user is anonymous
2450 if ( !$this->isItemLoaded( 'id' ) ) {
2451 // Don't load if this was initialized from an ID
2455 return (int)$this->mId
;
2459 * Set the user and reload all fields according to a given ID
2460 * @param int $v User ID to reload
2462 public function setId( $v ) {
2464 $this->clearInstanceCache( 'id' );
2468 * Get the user name, or the IP of an anonymous user
2469 * @return string User's name or IP address
2471 public function getName() {
2472 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2473 // Special case optimisation
2474 return $this->mName
;
2478 if ( $this->mName
=== false ) {
2480 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2483 return $this->mName
;
2487 * Set the user name.
2489 * This does not reload fields from the database according to the given
2490 * name. Rather, it is used to create a temporary "nonexistent user" for
2491 * later addition to the database. It can also be used to set the IP
2492 * address for an anonymous user to something other than the current
2495 * @note User::newFromName() has roughly the same function, when the named user
2497 * @param string $str New user name to set
2499 public function setName( $str ) {
2501 $this->mName
= $str;
2505 * Get the user's actor ID.
2507 * @param IDatabase|null $dbw Assign a new actor ID, using this DB handle, if none exists
2508 * @return int The actor's ID, or 0 if no actor ID exists and $dbw was null
2510 public function getActorId( IDatabase
$dbw = null ) {
2511 global $wgActorTableSchemaMigrationStage;
2513 // Technically we should always return 0 without SCHEMA_COMPAT_READ_NEW,
2514 // but it does little harm and might be needed for write callers loading a User.
2515 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) ) {
2519 if ( !$this->isItemLoaded( 'actor' ) ) {
2523 // Currently $this->mActorId might be null if $this was loaded from a
2524 // cache entry that was written when $wgActorTableSchemaMigrationStage
2525 // was SCHEMA_COMPAT_OLD. Once that is no longer a possibility (i.e. when
2526 // User::VERSION is incremented after $wgActorTableSchemaMigrationStage
2527 // has been removed), that condition may be removed.
2528 if ( $this->mActorId
=== null ||
!$this->mActorId
&& $dbw ) {
2530 'actor_user' => $this->getId() ?
: null,
2531 'actor_name' => (string)$this->getName(),
2534 if ( $q['actor_user'] === null && self
::isUsableName( $q['actor_name'] ) ) {
2535 throw new CannotCreateActorException(
2536 'Cannot create an actor for a usable name that is not an existing user'
2539 if ( $q['actor_name'] === '' ) {
2540 throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
2542 $dbw->insert( 'actor', $q, __METHOD__
, [ 'IGNORE' ] );
2543 if ( $dbw->affectedRows() ) {
2544 $this->mActorId
= (int)$dbw->insertId();
2547 // Use LOCK IN SHARE MODE to bypass any MySQL REPEATABLE-READ snapshot.
2548 $this->mActorId
= (int)$dbw->selectField(
2553 [ 'LOCK IN SHARE MODE' ]
2555 if ( !$this->mActorId
) {
2556 throw new CannotCreateActorException(
2557 "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
2561 $this->invalidateCache();
2563 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2564 $db = wfGetDB( $index );
2565 $this->mActorId
= (int)$db->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2567 $this->setItemLoaded( 'actor' );
2570 return (int)$this->mActorId
;
2574 * Get the user's name escaped by underscores.
2575 * @return string Username escaped by underscores.
2577 public function getTitleKey() {
2578 return str_replace( ' ', '_', $this->getName() );
2582 * Check if the user has new messages.
2583 * @return bool True if the user has new messages
2585 public function getNewtalk() {
2588 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2589 if ( $this->mNewtalk
=== -1 ) {
2590 $this->mNewtalk
= false; # reset talk page status
2592 // Check memcached separately for anons, who have no
2593 // entire User object stored in there.
2594 if ( !$this->mId
) {
2595 global $wgDisableAnonTalk;
2596 if ( $wgDisableAnonTalk ) {
2597 // Anon newtalk disabled by configuration.
2598 $this->mNewtalk
= false;
2600 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2603 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2607 return (bool)$this->mNewtalk
;
2611 * Return the data needed to construct links for new talk page message
2612 * alerts. If there are new messages, this will return an associative array
2613 * with the following data:
2614 * wiki: The database name of the wiki
2615 * link: Root-relative link to the user's talk page
2616 * rev: The last talk page revision that the user has seen or null. This
2617 * is useful for building diff links.
2618 * If there are no new messages, it returns an empty array.
2619 * @note This function was designed to accomodate multiple talk pages, but
2620 * currently only returns a single link and revision.
2623 public function getNewMessageLinks() {
2624 // Avoid PHP 7.1 warning of passing $this by reference
2627 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
2631 if ( !$this->getNewtalk() ) {
2634 $utp = $this->getTalkPage();
2635 $dbr = wfGetDB( DB_REPLICA
);
2636 // Get the "last viewed rev" timestamp from the oldest message notification
2637 $timestamp = $dbr->selectField( 'user_newtalk',
2638 'MIN(user_last_timestamp)',
2639 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2641 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2644 'wiki' => WikiMap
::getWikiIdFromDbDomain( WikiMap
::getCurrentWikiDbDomain() ),
2645 'link' => $utp->getLocalURL(),
2652 * Get the revision ID for the last talk page revision viewed by the talk
2654 * @return int|null Revision ID or null
2656 public function getNewMessageRevisionId() {
2657 $newMessageRevisionId = null;
2658 $newMessageLinks = $this->getNewMessageLinks();
2660 // Note: getNewMessageLinks() never returns more than a single link
2661 // and it is always for the same wiki, but we double-check here in
2662 // case that changes some time in the future.
2663 if ( $newMessageLinks && count( $newMessageLinks ) === 1
2664 && WikiMap
::isCurrentWikiId( $newMessageLinks[0]['wiki'] )
2665 && $newMessageLinks[0]['rev']
2667 /** @var Revision $newMessageRevision */
2668 $newMessageRevision = $newMessageLinks[0]['rev'];
2669 $newMessageRevisionId = $newMessageRevision->getId();
2672 return $newMessageRevisionId;
2676 * Internal uncached check for new messages
2679 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2680 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2681 * @return bool True if the user has new messages
2683 protected function checkNewtalk( $field, $id ) {
2684 $dbr = wfGetDB( DB_REPLICA
);
2686 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2688 return $ok !== false;
2692 * Add or update the new messages flag
2693 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2694 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2695 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2696 * @return bool True if successful, false otherwise
2698 protected function updateNewtalk( $field, $id, $curRev = null ) {
2699 // Get timestamp of the talk page revision prior to the current one
2700 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2701 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2702 // Mark the user as having new messages since this revision
2703 $dbw = wfGetDB( DB_MASTER
);
2704 $dbw->insert( 'user_newtalk',
2705 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2708 if ( $dbw->affectedRows() ) {
2709 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2713 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2718 * Clear the new messages flag for the given user
2719 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2720 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2721 * @return bool True if successful, false otherwise
2723 protected function deleteNewtalk( $field, $id ) {
2724 $dbw = wfGetDB( DB_MASTER
);
2725 $dbw->delete( 'user_newtalk',
2728 if ( $dbw->affectedRows() ) {
2729 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2733 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2738 * Update the 'You have new messages!' status.
2739 * @param bool $val Whether the user has new messages
2740 * @param Revision|null $curRev New, as yet unseen revision of the user talk
2741 * page. Ignored if null or !$val.
2743 public function setNewtalk( $val, $curRev = null ) {
2744 if ( wfReadOnly() ) {
2749 $this->mNewtalk
= $val;
2751 if ( $this->isAnon() ) {
2753 $id = $this->getName();
2756 $id = $this->getId();
2760 $changed = $this->updateNewtalk( $field, $id, $curRev );
2762 $changed = $this->deleteNewtalk( $field, $id );
2766 $this->invalidateCache();
2771 * Generate a current or new-future timestamp to be stored in the
2772 * user_touched field when we update things.
2773 * @return string Timestamp in TS_MW format
2775 private function newTouchedTimestamp() {
2776 global $wgClockSkewFudge;
2778 $time = wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2779 if ( $this->mTouched
&& $time <= $this->mTouched
) {
2780 $time = wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2787 * Clear user data from memcached
2789 * Use after applying updates to the database; caller's
2790 * responsibility to update user_touched if appropriate.
2792 * Called implicitly from invalidateCache() and saveSettings().
2794 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2796 public function clearSharedCache( $mode = 'changed' ) {
2797 if ( !$this->getId() ) {
2801 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2802 $key = $this->getCacheKey( $cache );
2803 if ( $mode === 'refresh' ) {
2804 $cache->delete( $key, 1 );
2806 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2807 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2808 $lb->getConnection( DB_MASTER
)->onTransactionPreCommitOrIdle(
2809 function () use ( $cache, $key ) {
2810 $cache->delete( $key );
2815 $cache->delete( $key );
2821 * Immediately touch the user data cache for this account
2823 * Calls touch() and removes account data from memcached
2825 public function invalidateCache() {
2827 $this->clearSharedCache();
2831 * Update the "touched" timestamp for the user
2833 * This is useful on various login/logout events when making sure that
2834 * a browser or proxy that has multiple tenants does not suffer cache
2835 * pollution where the new user sees the old users content. The value
2836 * of getTouched() is checked when determining 304 vs 200 responses.
2837 * Unlike invalidateCache(), this preserves the User object cache and
2838 * avoids database writes.
2842 public function touch() {
2843 $id = $this->getId();
2845 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2846 $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
2847 $cache->touchCheckKey( $key );
2848 $this->mQuickTouched
= null;
2853 * Validate the cache for this account.
2854 * @param string $timestamp A timestamp in TS_MW format
2857 public function validateCache( $timestamp ) {
2858 return ( $timestamp >= $this->getTouched() );
2862 * Get the user touched timestamp
2864 * Use this value only to validate caches via inequalities
2865 * such as in the case of HTTP If-Modified-Since response logic
2867 * @return string TS_MW Timestamp
2869 public function getTouched() {
2873 if ( $this->mQuickTouched
=== null ) {
2874 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2875 $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId
);
2877 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2880 return max( $this->mTouched
, $this->mQuickTouched
);
2883 return $this->mTouched
;
2887 * Get the user_touched timestamp field (time of last DB updates)
2888 * @return string TS_MW Timestamp
2891 public function getDBTouched() {
2894 return $this->mTouched
;
2898 * Set the password and reset the random token.
2899 * Calls through to authentication plugin if necessary;
2900 * will have no effect if the auth plugin refuses to
2901 * pass the change through or if the legal password
2904 * As a special case, setting the password to null
2905 * wipes it, so the account cannot be logged in until
2906 * a new password is set, for instance via e-mail.
2908 * @deprecated since 1.27, use AuthManager instead
2909 * @param string $str New password to set
2910 * @throws PasswordError On failure
2913 public function setPassword( $str ) {
2914 wfDeprecated( __METHOD__
, '1.27' );
2915 return $this->setPasswordInternal( $str );
2919 * Set the password and reset the random token unconditionally.
2921 * @deprecated since 1.27, use AuthManager instead
2922 * @param string|null $str New password to set or null to set an invalid
2923 * password hash meaning that the user will not be able to log in
2924 * through the web interface.
2926 public function setInternalPassword( $str ) {
2927 wfDeprecated( __METHOD__
, '1.27' );
2928 $this->setPasswordInternal( $str );
2932 * Actually set the password and such
2933 * @since 1.27 cannot set a password for a user not in the database
2934 * @param string|null $str New password to set or null to set an invalid
2935 * password hash meaning that the user will not be able to log in
2936 * through the web interface.
2937 * @return bool Success
2939 private function setPasswordInternal( $str ) {
2940 $manager = AuthManager
::singleton();
2942 // If the user doesn't exist yet, fail
2943 if ( !$manager->userExists( $this->getName() ) ) {
2944 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2947 $status = $this->changeAuthenticationData( [
2948 'username' => $this->getName(),
2952 if ( !$status->isGood() ) {
2953 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2954 ->info( __METHOD__
. ': Password change rejected: '
2955 . $status->getWikiText( null, null, 'en' ) );
2959 $this->setOption( 'watchlisttoken', false );
2960 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2966 * Changes credentials of the user.
2968 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2969 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2970 * e.g. when no provider handled the change.
2972 * @param array $data A set of authentication data in fieldname => value format. This is the
2973 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2977 public function changeAuthenticationData( array $data ) {
2978 $manager = AuthManager
::singleton();
2979 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2980 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2982 $status = Status
::newGood( 'ignored' );
2983 foreach ( $reqs as $req ) {
2984 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2986 if ( $status->getValue() === 'ignored' ) {
2987 $status->warning( 'authenticationdatachange-ignored' );
2990 if ( $status->isGood() ) {
2991 foreach ( $reqs as $req ) {
2992 $manager->changeAuthenticationData( $req );
2999 * Get the user's current token.
3000 * @param bool $forceCreation Force the generation of a new token if the
3001 * user doesn't have one (default=true for backwards compatibility).
3002 * @return string|null Token
3004 public function getToken( $forceCreation = true ) {
3005 global $wgAuthenticationTokenVersion;
3008 if ( !$this->mToken
&& $forceCreation ) {
3012 if ( !$this->mToken
) {
3013 // The user doesn't have a token, return null to indicate that.
3017 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
3018 // We return a random value here so existing token checks are very
3020 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3023 if ( $wgAuthenticationTokenVersion === null ) {
3024 // $wgAuthenticationTokenVersion not in use, so return the raw secret
3025 return $this->mToken
;
3028 // $wgAuthenticationTokenVersion in use, so hmac it.
3029 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
3031 // The raw hash can be overly long. Shorten it up.
3032 $len = max( 32, self
::TOKEN_LENGTH
);
3033 if ( strlen( $ret ) < $len ) {
3034 // Should never happen, even md5 is 128 bits
3035 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
3038 return substr( $ret, -$len );
3042 * Set the random token (used for persistent authentication)
3043 * Called from loadDefaults() among other places.
3045 * @param string|bool $token If specified, set the token to this value
3047 public function setToken( $token = false ) {
3049 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
3050 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3051 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
3052 } elseif ( !$token ) {
3053 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3055 $this->mToken
= $token;
3060 * Set the password for a password reminder or new account email
3062 * @deprecated Removed in 1.27. Use PasswordReset instead.
3063 * @param string $str New password to set or null to set an invalid
3064 * password hash meaning that the user will not be able to use it
3065 * @param bool $throttle If true, reset the throttle timestamp to the present
3067 public function setNewpassword( $str, $throttle = true ) {
3068 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
3072 * Get the user's e-mail address
3073 * @return string User's email address
3075 public function getEmail() {
3077 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
3078 return $this->mEmail
;
3082 * Get the timestamp of the user's e-mail authentication
3083 * @return string TS_MW timestamp
3085 public function getEmailAuthenticationTimestamp() {
3087 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
3088 return $this->mEmailAuthenticated
;
3092 * Set the user's e-mail address
3093 * @param string $str New e-mail address
3095 public function setEmail( $str ) {
3097 if ( $str == $this->mEmail
) {
3100 $this->invalidateEmail();
3101 $this->mEmail
= $str;
3102 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
3106 * Set the user's e-mail address and a confirmation mail if needed.
3109 * @param string $str New e-mail address
3112 public function setEmailWithConfirmation( $str ) {
3113 global $wgEnableEmail, $wgEmailAuthentication;
3115 if ( !$wgEnableEmail ) {
3116 return Status
::newFatal( 'emaildisabled' );
3119 $oldaddr = $this->getEmail();
3120 if ( $str === $oldaddr ) {
3121 return Status
::newGood( true );
3124 $type = $oldaddr != '' ?
'changed' : 'set';
3125 $notificationResult = null;
3127 if ( $wgEmailAuthentication && $type === 'changed' ) {
3128 // Send the user an email notifying the user of the change in registered
3129 // email address on their previous email address
3130 $change = $str != '' ?
'changed' : 'removed';
3131 $notificationResult = $this->sendMail(
3132 wfMessage( 'notificationemail_subject_' . $change )->text(),
3133 wfMessage( 'notificationemail_body_' . $change,
3134 $this->getRequest()->getIP(),
3140 $this->setEmail( $str );
3142 if ( $str !== '' && $wgEmailAuthentication ) {
3143 // Send a confirmation request to the new address if needed
3144 $result = $this->sendConfirmationMail( $type );
3146 if ( $notificationResult !== null ) {
3147 $result->merge( $notificationResult );
3150 if ( $result->isGood() ) {
3151 // Say to the caller that a confirmation and notification mail has been sent
3152 $result->value
= 'eauth';
3155 $result = Status
::newGood( true );
3162 * Get the user's real name
3163 * @return string User's real name
3165 public function getRealName() {
3166 if ( !$this->isItemLoaded( 'realname' ) ) {
3170 return $this->mRealName
;
3174 * Set the user's real name
3175 * @param string $str New real name
3177 public function setRealName( $str ) {
3179 $this->mRealName
= $str;
3183 * Get the user's current setting for a given option.
3185 * @param string $oname The option to check
3186 * @param string|array|null $defaultOverride A default value returned if the option does not exist
3187 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
3188 * @return string|array|int|null User's current value for the option
3189 * @see getBoolOption()
3190 * @see getIntOption()
3192 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
3193 global $wgHiddenPrefs;
3194 $this->loadOptions();
3196 # We want 'disabled' preferences to always behave as the default value for
3197 # users, even if they have set the option explicitly in their settings (ie they
3198 # set it, and then it was disabled removing their ability to change it). But
3199 # we don't want to erase the preferences in the database in case the preference
3200 # is re-enabled again. So don't touch $mOptions, just override the returned value
3201 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
3202 return self
::getDefaultOption( $oname );
3205 if ( array_key_exists( $oname, $this->mOptions
) ) {
3206 return $this->mOptions
[$oname];
3209 return $defaultOverride;
3213 * Get all user's options
3215 * @param int $flags Bitwise combination of:
3216 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
3217 * to the default value. (Since 1.25)
3220 public function getOptions( $flags = 0 ) {
3221 global $wgHiddenPrefs;
3222 $this->loadOptions();
3223 $options = $this->mOptions
;
3225 # We want 'disabled' preferences to always behave as the default value for
3226 # users, even if they have set the option explicitly in their settings (ie they
3227 # set it, and then it was disabled removing their ability to change it). But
3228 # we don't want to erase the preferences in the database in case the preference
3229 # is re-enabled again. So don't touch $mOptions, just override the returned value
3230 foreach ( $wgHiddenPrefs as $pref ) {
3231 $default = self
::getDefaultOption( $pref );
3232 if ( $default !== null ) {
3233 $options[$pref] = $default;
3237 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
3238 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
3245 * Get the user's current setting for a given option, as a boolean value.
3247 * @param string $oname The option to check
3248 * @return bool User's current value for the option
3251 public function getBoolOption( $oname ) {
3252 return (bool)$this->getOption( $oname );
3256 * Get the user's current setting for a given option, as an integer value.
3258 * @param string $oname The option to check
3259 * @param int $defaultOverride A default value returned if the option does not exist
3260 * @return int User's current value for the option
3263 public function getIntOption( $oname, $defaultOverride = 0 ) {
3264 $val = $this->getOption( $oname );
3266 $val = $defaultOverride;
3268 return intval( $val );
3272 * Set the given option for a user.
3274 * You need to call saveSettings() to actually write to the database.
3276 * @param string $oname The option to set
3277 * @param mixed $val New value to set
3279 public function setOption( $oname, $val ) {
3280 $this->loadOptions();
3282 // Explicitly NULL values should refer to defaults
3283 if ( is_null( $val ) ) {
3284 $val = self
::getDefaultOption( $oname );
3287 $this->mOptions
[$oname] = $val;
3291 * Get a token stored in the preferences (like the watchlist one),
3292 * resetting it if it's empty (and saving changes).
3294 * @param string $oname The option name to retrieve the token from
3295 * @return string|bool User's current value for the option, or false if this option is disabled.
3296 * @see resetTokenFromOption()
3298 * @deprecated since 1.26 Applications should use the OAuth extension
3300 public function getTokenFromOption( $oname ) {
3301 global $wgHiddenPrefs;
3303 $id = $this->getId();
3304 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
3308 $token = $this->getOption( $oname );
3310 // Default to a value based on the user token to avoid space
3311 // wasted on storing tokens for all users. When this option
3312 // is set manually by the user, only then is it stored.
3313 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
3320 * Reset a token stored in the preferences (like the watchlist one).
3321 * *Does not* save user's preferences (similarly to setOption()).
3323 * @param string $oname The option name to reset the token in
3324 * @return string|bool New token value, or false if this option is disabled.
3325 * @see getTokenFromOption()
3328 public function resetTokenFromOption( $oname ) {
3329 global $wgHiddenPrefs;
3330 if ( in_array( $oname, $wgHiddenPrefs ) ) {
3334 $token = MWCryptRand
::generateHex( 40 );
3335 $this->setOption( $oname, $token );
3340 * Return a list of the types of user options currently returned by
3341 * User::getOptionKinds().
3343 * Currently, the option kinds are:
3344 * - 'registered' - preferences which are registered in core MediaWiki or
3345 * by extensions using the UserGetDefaultOptions hook.
3346 * - 'registered-multiselect' - as above, using the 'multiselect' type.
3347 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
3348 * - 'userjs' - preferences with names starting with 'userjs-', intended to
3349 * be used by user scripts.
3350 * - 'special' - "preferences" that are not accessible via User::getOptions
3351 * or User::setOptions.
3352 * - 'unused' - preferences about which MediaWiki doesn't know anything.
3353 * These are usually legacy options, removed in newer versions.
3355 * The API (and possibly others) use this function to determine the possible
3356 * option types for validation purposes, so make sure to update this when a
3357 * new option kind is added.
3359 * @see User::getOptionKinds
3360 * @return array Option kinds
3362 public static function listOptionKinds() {
3365 'registered-multiselect',
3366 'registered-checkmatrix',
3374 * Return an associative array mapping preferences keys to the kind of a preference they're
3375 * used for. Different kinds are handled differently when setting or reading preferences.
3377 * See User::listOptionKinds for the list of valid option types that can be provided.
3379 * @see User::listOptionKinds
3380 * @param IContextSource $context
3381 * @param array|null $options Assoc. array with options keys to check as keys.
3382 * Defaults to $this->mOptions.
3383 * @return array The key => kind mapping data
3385 public function getOptionKinds( IContextSource
$context, $options = null ) {
3386 $this->loadOptions();
3387 if ( $options === null ) {
3388 $options = $this->mOptions
;
3391 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
3392 $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
3395 // Pull out the "special" options, so they don't get converted as
3396 // multiselect or checkmatrix.
3397 $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
3398 foreach ( $specialOptions as $name => $value ) {
3399 unset( $prefs[$name] );
3402 // Multiselect and checkmatrix options are stored in the database with
3403 // one key per option, each having a boolean value. Extract those keys.
3404 $multiselectOptions = [];
3405 foreach ( $prefs as $name => $info ) {
3406 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3407 ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField
::class ) ) {
3408 $opts = HTMLFormField
::flattenOptions( $info['options'] );
3409 $prefix = $info['prefix'] ??
$name;
3411 foreach ( $opts as $value ) {
3412 $multiselectOptions["$prefix$value"] = true;
3415 unset( $prefs[$name] );
3418 $checkmatrixOptions = [];
3419 foreach ( $prefs as $name => $info ) {
3420 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3421 ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix
::class ) ) {
3422 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3423 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3424 $prefix = $info['prefix'] ??
$name;
3426 foreach ( $columns as $column ) {
3427 foreach ( $rows as $row ) {
3428 $checkmatrixOptions["$prefix$column-$row"] = true;
3432 unset( $prefs[$name] );
3436 // $value is ignored
3437 foreach ( $options as $key => $value ) {
3438 if ( isset( $prefs[$key] ) ) {
3439 $mapping[$key] = 'registered';
3440 } elseif ( isset( $multiselectOptions[$key] ) ) {
3441 $mapping[$key] = 'registered-multiselect';
3442 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3443 $mapping[$key] = 'registered-checkmatrix';
3444 } elseif ( isset( $specialOptions[$key] ) ) {
3445 $mapping[$key] = 'special';
3446 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3447 $mapping[$key] = 'userjs';
3449 $mapping[$key] = 'unused';
3457 * Reset certain (or all) options to the site defaults
3459 * The optional parameter determines which kinds of preferences will be reset.
3460 * Supported values are everything that can be reported by getOptionKinds()
3461 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3463 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3464 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3465 * for backwards-compatibility.
3466 * @param IContextSource|null $context Context source used when $resetKinds
3467 * does not contain 'all', passed to getOptionKinds().
3468 * Defaults to RequestContext::getMain() when null.
3470 public function resetOptions(
3471 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3472 IContextSource
$context = null
3475 $defaultOptions = self
::getDefaultOptions();
3477 if ( !is_array( $resetKinds ) ) {
3478 $resetKinds = [ $resetKinds ];
3481 if ( in_array( 'all', $resetKinds ) ) {
3482 $newOptions = $defaultOptions;
3484 if ( $context === null ) {
3485 $context = RequestContext
::getMain();
3488 $optionKinds = $this->getOptionKinds( $context );
3489 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3492 // Use default values for the options that should be deleted, and
3493 // copy old values for the ones that shouldn't.
3494 foreach ( $this->mOptions
as $key => $value ) {
3495 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3496 if ( array_key_exists( $key, $defaultOptions ) ) {
3497 $newOptions[$key] = $defaultOptions[$key];
3500 $newOptions[$key] = $value;
3505 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3507 $this->mOptions
= $newOptions;
3508 $this->mOptionsLoaded
= true;
3512 * Get the user's preferred date format.
3513 * @return string User's preferred date format
3515 public function getDatePreference() {
3516 // Important migration for old data rows
3517 if ( is_null( $this->mDatePreference
) ) {
3519 $value = $this->getOption( 'date' );
3520 $map = $wgLang->getDatePreferenceMigrationMap();
3521 if ( isset( $map[$value] ) ) {
3522 $value = $map[$value];
3524 $this->mDatePreference
= $value;
3526 return $this->mDatePreference
;
3530 * Determine based on the wiki configuration and the user's options,
3531 * whether this user must be over HTTPS no matter what.
3535 public function requiresHTTPS() {
3536 global $wgSecureLogin;
3537 if ( !$wgSecureLogin ) {
3541 $https = $this->getBoolOption( 'prefershttps' );
3542 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3544 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3551 * Get the user preferred stub threshold
3555 public function getStubThreshold() {
3556 global $wgMaxArticleSize; # Maximum article size, in Kb
3557 $threshold = $this->getIntOption( 'stubthreshold' );
3558 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3559 // If they have set an impossible value, disable the preference
3560 // so we can use the parser cache again.
3567 * Get the permissions this user has.
3568 * @return string[] permission names
3570 public function getRights() {
3571 if ( is_null( $this->mRights
) ) {
3572 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3573 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3575 // Deny any rights denied by the user's session, unless this
3576 // endpoint has no sessions.
3577 if ( !defined( 'MW_NO_SESSION' ) ) {
3578 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3579 if ( $allowedRights !== null ) {
3580 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3584 Hooks
::run( 'UserGetRightsRemove', [ $this, &$this->mRights
] );
3585 // Force reindexation of rights when a hook has unset one of them
3586 $this->mRights
= array_values( array_unique( $this->mRights
) );
3588 // If block disables login, we should also remove any
3589 // extra rights blocked users might have, in case the
3590 // blocked user has a pre-existing session (T129738).
3591 // This is checked here for cases where people only call
3592 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3593 // to give a better error message in the common case.
3594 $config = RequestContext
::getMain()->getConfig();
3596 $this->isLoggedIn() &&
3597 $config->get( 'BlockDisablesLogin' ) &&
3601 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3604 return $this->mRights
;
3608 * Get the list of explicit group memberships this user has.
3609 * The implicit * and user groups are not included.
3611 * @return string[] Array of internal group names (sorted since 1.33)
3613 public function getGroups() {
3615 $this->loadGroups();
3616 return array_keys( $this->mGroupMemberships
);
3620 * Get the list of explicit group memberships this user has, stored as
3621 * UserGroupMembership objects. Implicit groups are not included.
3623 * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
3626 public function getGroupMemberships() {
3628 $this->loadGroups();
3629 return $this->mGroupMemberships
;
3633 * Get the list of implicit group memberships this user has.
3634 * This includes all explicit groups, plus 'user' if logged in,
3635 * '*' for all accounts, and autopromoted groups
3636 * @param bool $recache Whether to avoid the cache
3637 * @return array Array of String internal group names
3639 public function getEffectiveGroups( $recache = false ) {
3640 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3641 $this->mEffectiveGroups
= array_unique( array_merge(
3642 $this->getGroups(), // explicit groups
3643 $this->getAutomaticGroups( $recache ) // implicit groups
3645 // Avoid PHP 7.1 warning of passing $this by reference
3647 // Hook for additional groups
3648 Hooks
::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups
] );
3649 // Force reindexation of groups when a hook has unset one of them
3650 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3652 return $this->mEffectiveGroups
;
3656 * Get the list of implicit group memberships this user has.
3657 * This includes 'user' if logged in, '*' for all accounts,
3658 * and autopromoted groups
3659 * @param bool $recache Whether to avoid the cache
3660 * @return array Array of String internal group names
3662 public function getAutomaticGroups( $recache = false ) {
3663 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3664 $this->mImplicitGroups
= [ '*' ];
3665 if ( $this->getId() ) {
3666 $this->mImplicitGroups
[] = 'user';
3668 $this->mImplicitGroups
= array_unique( array_merge(
3669 $this->mImplicitGroups
,
3670 Autopromote
::getAutopromoteGroups( $this )
3674 // Assure data consistency with rights/groups,
3675 // as getEffectiveGroups() depends on this function
3676 $this->mEffectiveGroups
= null;
3679 return $this->mImplicitGroups
;
3683 * Returns the groups the user has belonged to.
3685 * The user may still belong to the returned groups. Compare with getGroups().
3687 * The function will not return groups the user had belonged to before MW 1.17
3689 * @return array Names of the groups the user has belonged to.
3691 public function getFormerGroups() {
3694 if ( is_null( $this->mFormerGroups
) ) {
3695 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3696 ?
wfGetDB( DB_MASTER
)
3697 : wfGetDB( DB_REPLICA
);
3698 $res = $db->select( 'user_former_groups',
3700 [ 'ufg_user' => $this->mId
],
3702 $this->mFormerGroups
= [];
3703 foreach ( $res as $row ) {
3704 $this->mFormerGroups
[] = $row->ufg_group
;
3708 return $this->mFormerGroups
;
3712 * Get the user's edit count.
3713 * @return int|null Null for anonymous users
3715 public function getEditCount() {
3716 if ( !$this->getId() ) {
3720 if ( $this->mEditCount
=== null ) {
3721 /* Populate the count, if it has not been populated yet */
3722 $dbr = wfGetDB( DB_REPLICA
);
3723 // check if the user_editcount field has been initialized
3724 $count = $dbr->selectField(
3725 'user', 'user_editcount',
3726 [ 'user_id' => $this->mId
],
3730 if ( $count === null ) {
3731 // it has not been initialized. do so.
3732 $count = $this->initEditCountInternal();
3734 $this->mEditCount
= $count;
3736 return (int)$this->mEditCount
;
3740 * Add the user to the given group. This takes immediate effect.
3741 * If the user is already in the group, the expiry time will be updated to the new
3742 * expiry time. (If $expiry is omitted or null, the membership will be altered to
3745 * @param string $group Name of the group to add
3746 * @param string|null $expiry Optional expiry timestamp in any format acceptable to
3747 * wfTimestamp(), or null if the group assignment should not expire
3750 public function addGroup( $group, $expiry = null ) {
3752 $this->loadGroups();
3755 $expiry = wfTimestamp( TS_MW
, $expiry );
3758 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
3762 // create the new UserGroupMembership and put it in the DB
3763 $ugm = new UserGroupMembership( $this->mId
, $group, $expiry );
3764 if ( !$ugm->insert( true ) ) {
3768 $this->mGroupMemberships
[$group] = $ugm;
3770 // Refresh the groups caches, and clear the rights cache so it will be
3771 // refreshed on the next call to $this->getRights().
3772 $this->getEffectiveGroups( true );
3773 $this->mRights
= null;
3775 $this->invalidateCache();
3781 * Remove the user from the given group.
3782 * This takes immediate effect.
3783 * @param string $group Name of the group to remove
3786 public function removeGroup( $group ) {
3789 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3793 $ugm = UserGroupMembership
::getMembership( $this->mId
, $group );
3794 // delete the membership entry
3795 if ( !$ugm ||
!$ugm->delete() ) {
3799 $this->loadGroups();
3800 unset( $this->mGroupMemberships
[$group] );
3802 // Refresh the groups caches, and clear the rights cache so it will be
3803 // refreshed on the next call to $this->getRights().
3804 $this->getEffectiveGroups( true );
3805 $this->mRights
= null;
3807 $this->invalidateCache();
3813 * Get whether the user is logged in
3816 public function isLoggedIn() {
3817 return $this->getId() != 0;
3821 * Get whether the user is anonymous
3824 public function isAnon() {
3825 return !$this->isLoggedIn();
3829 * @return bool Whether this user is flagged as being a bot role account
3832 public function isBot() {
3833 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3838 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3844 * Check if user is allowed to access a feature / make an action
3846 * @param string $permissions,... Permissions to test
3847 * @return bool True if user is allowed to perform *any* of the given actions
3849 public function isAllowedAny() {
3850 $permissions = func_get_args();
3851 foreach ( $permissions as $permission ) {
3852 if ( $this->isAllowed( $permission ) ) {
3861 * @param string $permissions,... Permissions to test
3862 * @return bool True if the user is allowed to perform *all* of the given actions
3864 public function isAllowedAll() {
3865 $permissions = func_get_args();
3866 foreach ( $permissions as $permission ) {
3867 if ( !$this->isAllowed( $permission ) ) {
3875 * Internal mechanics of testing a permission
3876 * @param string $action
3879 public function isAllowed( $action = '' ) {
3880 if ( $action === '' ) {
3881 return true; // In the spirit of DWIM
3883 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3884 // by misconfiguration: 0 == 'foo'
3885 return in_array( $action, $this->getRights(), true );
3889 * Check whether to enable recent changes patrol features for this user
3890 * @return bool True or false
3892 public function useRCPatrol() {
3893 global $wgUseRCPatrol;
3894 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3898 * Check whether to enable new pages patrol features for this user
3899 * @return bool True or false
3901 public function useNPPatrol() {
3902 global $wgUseRCPatrol, $wgUseNPPatrol;
3904 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3905 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3910 * Check whether to enable new files patrol features for this user
3911 * @return bool True or false
3913 public function useFilePatrol() {
3914 global $wgUseRCPatrol, $wgUseFilePatrol;
3916 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3917 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3922 * Get the WebRequest object to use with this object
3924 * @return WebRequest
3926 public function getRequest() {
3927 if ( $this->mRequest
) {
3928 return $this->mRequest
;
3936 * Check the watched status of an article.
3937 * @since 1.22 $checkRights parameter added
3938 * @param Title $title Title of the article to look at
3939 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3940 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3943 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3944 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3945 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3952 * @since 1.22 $checkRights parameter added
3953 * @param Title $title Title of the article to look at
3954 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3955 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3957 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3958 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3959 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3961 [ $title->getSubjectPage(), $title->getTalkPage() ]
3964 $this->invalidateCache();
3968 * Stop watching an article.
3969 * @since 1.22 $checkRights parameter added
3970 * @param Title $title Title of the article to look at
3971 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3972 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3974 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3975 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3976 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3977 $store->removeWatch( $this, $title->getSubjectPage() );
3978 $store->removeWatch( $this, $title->getTalkPage() );
3980 $this->invalidateCache();
3984 * Clear the user's notification timestamp for the given title.
3985 * If e-notif e-mails are on, they will receive notification mails on
3986 * the next change of the page if it's watched etc.
3987 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3988 * @param Title &$title Title of the article to look at
3989 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3991 public function clearNotification( &$title, $oldid = 0 ) {
3992 global $wgUseEnotif, $wgShowUpdatedMarker;
3994 // Do nothing if the database is locked to writes
3995 if ( wfReadOnly() ) {
3999 // Do nothing if not allowed to edit the watchlist
4000 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
4004 // If we're working on user's talk page, we should update the talk page message indicator
4005 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
4006 // Avoid PHP 7.1 warning of passing $this by reference
4008 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
4012 // Try to update the DB post-send and only if needed...
4013 DeferredUpdates
::addCallableUpdate( function () use ( $title, $oldid ) {
4014 if ( !$this->getNewtalk() ) {
4015 return; // no notifications to clear
4018 // Delete the last notifications (they stack up)
4019 $this->setNewtalk( false );
4021 // If there is a new, unseen, revision, use its timestamp
4023 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
4026 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
4031 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4035 if ( $this->isAnon() ) {
4036 // Nothing else to do...
4040 // Only update the timestamp if the page is being watched.
4041 // The query to find out if it is watched is cached both in memcached and per-invocation,
4042 // and when it does have to be executed, it can be on a replica DB
4043 // If this is the user's newtalk page, we always update the timestamp
4045 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
4049 MediaWikiServices
::getInstance()->getWatchedItemStore()
4050 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
4054 * Resets all of the given user's page-change notification timestamps.
4055 * If e-notif e-mails are on, they will receive notification mails on
4056 * the next change of any watched page.
4057 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
4059 public function clearAllNotifications() {
4060 global $wgUseEnotif, $wgShowUpdatedMarker;
4061 // Do nothing if not allowed to edit the watchlist
4062 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
4066 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4067 $this->setNewtalk( false );
4071 $id = $this->getId();
4076 $watchedItemStore = MediaWikiServices
::getInstance()->getWatchedItemStore();
4077 $watchedItemStore->resetAllNotificationTimestampsForUser( $this );
4079 // We also need to clear here the "you have new message" notification for the own
4080 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
4084 * Compute experienced level based on edit count and registration date.
4086 * @return string 'newcomer', 'learner', or 'experienced'
4088 public function getExperienceLevel() {
4089 global $wgLearnerEdits,
4090 $wgExperiencedUserEdits,
4091 $wgLearnerMemberSince,
4092 $wgExperiencedUserMemberSince;
4094 if ( $this->isAnon() ) {
4098 $editCount = $this->getEditCount();
4099 $registration = $this->getRegistration();
4101 $learnerRegistration = wfTimestamp( TS_MW
, $now - $wgLearnerMemberSince * 86400 );
4102 $experiencedRegistration = wfTimestamp( TS_MW
, $now - $wgExperiencedUserMemberSince * 86400 );
4104 if ( $editCount < $wgLearnerEdits ||
4105 $registration > $learnerRegistration ) {
4109 if ( $editCount > $wgExperiencedUserEdits &&
4110 $registration <= $experiencedRegistration
4112 return 'experienced';
4119 * Persist this user's session (e.g. set cookies)
4121 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
4123 * @param bool|null $secure Whether to force secure/insecure cookies or use default
4124 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
4126 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
4128 if ( $this->mId
== 0 ) {
4132 $session = $this->getRequest()->getSession();
4133 if ( $request && $session->getRequest() !== $request ) {
4134 $session = $session->sessionWithRequest( $request );
4136 $delay = $session->delaySave();
4138 if ( !$session->getUser()->equals( $this ) ) {
4139 if ( !$session->canSetUser() ) {
4140 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4141 ->warning( __METHOD__
.
4142 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
4146 $session->setUser( $this );
4149 $session->setRememberUser( $rememberMe );
4150 if ( $secure !== null ) {
4151 $session->setForceHTTPS( $secure );
4154 $session->persist();
4156 ScopedCallback
::consume( $delay );
4160 * Log this user out.
4162 public function logout() {
4163 // Avoid PHP 7.1 warning of passing $this by reference
4165 if ( Hooks
::run( 'UserLogout', [ &$user ] ) ) {
4171 * Clear the user's session, and reset the instance cache.
4174 public function doLogout() {
4175 $session = $this->getRequest()->getSession();
4176 if ( !$session->canSetUser() ) {
4177 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4178 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
4179 $error = 'immutable';
4180 } elseif ( !$session->getUser()->equals( $this ) ) {
4181 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4182 ->warning( __METHOD__
.
4183 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
4185 // But we still may as well make this user object anon
4186 $this->clearInstanceCache( 'defaults' );
4187 $error = 'wronguser';
4189 $this->clearInstanceCache( 'defaults' );
4190 $delay = $session->delaySave();
4191 $session->unpersist(); // Clear cookies (T127436)
4192 $session->setLoggedOutTimestamp( time() );
4193 $session->setUser( new User
);
4194 $session->set( 'wsUserID', 0 ); // Other code expects this
4195 $session->resetAllTokens();
4196 ScopedCallback
::consume( $delay );
4199 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
4200 'event' => 'logout',
4201 'successful' => $error === false,
4202 'status' => $error ?
: 'success',
4207 * Save this user's settings into the database.
4208 * @todo Only rarely do all these fields need to be set!
4210 public function saveSettings() {
4211 if ( wfReadOnly() ) {
4212 // @TODO: caller should deal with this instead!
4213 // This should really just be an exception.
4214 MWExceptionHandler
::logException( new DBExpectedError(
4216 "Could not update user with ID '{$this->mId}'; DB is read-only."
4222 if ( $this->mId
== 0 ) {
4226 // Get a new user_touched that is higher than the old one.
4227 // This will be used for a CAS check as a last-resort safety
4228 // check against race conditions and replica DB lag.
4229 $newTouched = $this->newTouchedTimestamp();
4231 $dbw = wfGetDB( DB_MASTER
);
4232 $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $newTouched ) {
4233 global $wgActorTableSchemaMigrationStage;
4235 $dbw->update( 'user',
4237 'user_name' => $this->mName
,
4238 'user_real_name' => $this->mRealName
,
4239 'user_email' => $this->mEmail
,
4240 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4241 'user_touched' => $dbw->timestamp( $newTouched ),
4242 'user_token' => strval( $this->mToken
),
4243 'user_email_token' => $this->mEmailToken
,
4244 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
4245 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
4246 'user_id' => $this->mId
,
4250 if ( !$dbw->affectedRows() ) {
4251 // Maybe the problem was a missed cache update; clear it to be safe
4252 $this->clearSharedCache( 'refresh' );
4253 // User was changed in the meantime or loaded with stale data
4254 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
4255 LoggerFactory
::getInstance( 'preferences' )->warning(
4256 "CAS update failed on user_touched for user ID '{user_id}' ({db_flag} read)",
4257 [ 'user_id' => $this->mId
, 'db_flag' => $from ]
4259 throw new MWException( "CAS update failed on user_touched. " .
4260 "The version of the user to be saved is older than the current version."
4264 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4267 [ 'actor_name' => $this->mName
],
4268 [ 'actor_user' => $this->mId
],
4274 $this->mTouched
= $newTouched;
4275 $this->saveOptions();
4277 Hooks
::run( 'UserSaveSettings', [ $this ] );
4278 $this->clearSharedCache();
4279 $this->getUserPage()->invalidateCache();
4283 * If only this user's username is known, and it exists, return the user ID.
4285 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
4288 public function idForName( $flags = 0 ) {
4289 $s = trim( $this->getName() );
4294 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
4295 ?
wfGetDB( DB_MASTER
)
4296 : wfGetDB( DB_REPLICA
);
4298 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
4299 ?
[ 'LOCK IN SHARE MODE' ]
4302 $id = $db->selectField( 'user',
4303 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
4309 * Add a user to the database, return the user object
4311 * @param string $name Username to add
4312 * @param array $params Array of Strings Non-default parameters to save to
4313 * the database as user_* fields:
4314 * - email: The user's email address.
4315 * - email_authenticated: The email authentication timestamp.
4316 * - real_name: The user's real name.
4317 * - options: An associative array of non-default options.
4318 * - token: Random authentication token. Do not set.
4319 * - registration: Registration timestamp. Do not set.
4321 * @return User|null User object, or null if the username already exists.
4323 public static function createNew( $name, $params = [] ) {
4324 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
4325 if ( isset( $params[$field] ) ) {
4326 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
4327 unset( $params[$field] );
4333 $user->setToken(); // init token
4334 if ( isset( $params['options'] ) ) {
4335 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
4336 unset( $params['options'] );
4338 $dbw = wfGetDB( DB_MASTER
);
4340 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4343 'user_name' => $name,
4344 'user_password' => $noPass,
4345 'user_newpassword' => $noPass,
4346 'user_email' => $user->mEmail
,
4347 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
4348 'user_real_name' => $user->mRealName
,
4349 'user_token' => strval( $user->mToken
),
4350 'user_registration' => $dbw->timestamp( $user->mRegistration
),
4351 'user_editcount' => 0,
4352 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4354 foreach ( $params as $name => $value ) {
4355 $fields["user_$name"] = $value;
4358 return $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $fields ) {
4359 $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
4360 if ( $dbw->affectedRows() ) {
4361 $newUser = self
::newFromId( $dbw->insertId() );
4362 $newUser->mName
= $fields['user_name'];
4363 $newUser->updateActorId( $dbw );
4364 // Load the user from master to avoid replica lag
4365 $newUser->load( self
::READ_LATEST
);
4374 * Add this existing user object to the database. If the user already
4375 * exists, a fatal status object is returned, and the user object is
4376 * initialised with the data from the database.
4378 * Previously, this function generated a DB error due to a key conflict
4379 * if the user already existed. Many extension callers use this function
4380 * in code along the lines of:
4382 * $user = User::newFromName( $name );
4383 * if ( !$user->isLoggedIn() ) {
4384 * $user->addToDatabase();
4386 * // do something with $user...
4388 * However, this was vulnerable to a race condition (T18020). By
4389 * initialising the user object if the user exists, we aim to support this
4390 * calling sequence as far as possible.
4392 * Note that if the user exists, this function will acquire a write lock,
4393 * so it is still advisable to make the call conditional on isLoggedIn(),
4394 * and to commit the transaction after calling.
4396 * @throws MWException
4399 public function addToDatabase() {
4401 if ( !$this->mToken
) {
4402 $this->setToken(); // init token
4405 if ( !is_string( $this->mName
) ) {
4406 throw new RuntimeException( "User name field is not set." );
4409 $this->mTouched
= $this->newTouchedTimestamp();
4411 $dbw = wfGetDB( DB_MASTER
);
4412 $status = $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) {
4413 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4414 $dbw->insert( 'user',
4416 'user_name' => $this->mName
,
4417 'user_password' => $noPass,
4418 'user_newpassword' => $noPass,
4419 'user_email' => $this->mEmail
,
4420 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4421 'user_real_name' => $this->mRealName
,
4422 'user_token' => strval( $this->mToken
),
4423 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4424 'user_editcount' => 0,
4425 'user_touched' => $dbw->timestamp( $this->mTouched
),
4429 if ( !$dbw->affectedRows() ) {
4430 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4431 $this->mId
= $dbw->selectField(
4434 [ 'user_name' => $this->mName
],
4436 [ 'LOCK IN SHARE MODE' ]
4440 if ( $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4445 throw new MWException( $fname . ": hit a key conflict attempting " .
4446 "to insert user '{$this->mName}' row, but it was not present in select!" );
4448 return Status
::newFatal( 'userexists' );
4450 $this->mId
= $dbw->insertId();
4451 self
::$idCacheByName[$this->mName
] = $this->mId
;
4452 $this->updateActorId( $dbw );
4454 return Status
::newGood();
4456 if ( !$status->isGood() ) {
4460 // Clear instance cache other than user table data and actor, which is already accurate
4461 $this->clearInstanceCache();
4463 $this->saveOptions();
4464 return Status
::newGood();
4468 * Update the actor ID after an insert
4469 * @param IDatabase $dbw Writable database handle
4471 private function updateActorId( IDatabase
$dbw ) {
4472 global $wgActorTableSchemaMigrationStage;
4474 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4477 [ 'actor_user' => $this->mId
, 'actor_name' => $this->mName
],
4480 $this->mActorId
= (int)$dbw->insertId();
4485 * If this user is logged-in and blocked,
4486 * block any IP address they've successfully logged in from.
4487 * @return bool A block was spread
4489 public function spreadAnyEditBlock() {
4490 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4491 return $this->spreadBlock();
4498 * If this (non-anonymous) user is blocked,
4499 * block the IP address they've successfully logged in from.
4500 * @return bool A block was spread
4502 protected function spreadBlock() {
4503 wfDebug( __METHOD__
. "()\n" );
4505 if ( $this->mId
== 0 ) {
4509 $userblock = Block
::newFromTarget( $this->getName() );
4510 if ( !$userblock ) {
4514 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4518 * Get whether the user is explicitly blocked from account creation.
4519 * @return bool|Block
4521 public function isBlockedFromCreateAccount() {
4522 $this->getBlockedStatus();
4523 if ( $this->mBlock
&& $this->mBlock
->appliesToRight( 'createaccount' ) ) {
4524 return $this->mBlock
;
4527 # T15611: if the IP address the user is trying to create an account from is
4528 # blocked with createaccount disabled, prevent new account creation there even
4529 # when the user is logged in
4530 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4531 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4533 return $this->mBlockedFromCreateAccount
instanceof Block
4534 && $this->mBlockedFromCreateAccount
->appliesToRight( 'createaccount' )
4535 ?
$this->mBlockedFromCreateAccount
4540 * Get whether the user is blocked from using Special:Emailuser.
4543 public function isBlockedFromEmailuser() {
4544 $this->getBlockedStatus();
4545 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'sendemail' );
4549 * Get whether the user is blocked from using Special:Upload
4554 public function isBlockedFromUpload() {
4555 $this->getBlockedStatus();
4556 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'upload' );
4560 * Get whether the user is allowed to create an account.
4563 public function isAllowedToCreateAccount() {
4564 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4568 * Get this user's personal page title.
4570 * @return Title User's personal page title
4572 public function getUserPage() {
4573 return Title
::makeTitle( NS_USER
, $this->getName() );
4577 * Get this user's talk page title.
4579 * @return Title User's talk page title
4581 public function getTalkPage() {
4582 $title = $this->getUserPage();
4583 return $title->getTalkPage();
4587 * Determine whether the user is a newbie. Newbies are either
4588 * anonymous IPs, or the most recently created accounts.
4591 public function isNewbie() {
4592 return !$this->isAllowed( 'autoconfirmed' );
4596 * Check to see if the given clear-text password is one of the accepted passwords
4597 * @deprecated since 1.27, use AuthManager instead
4598 * @param string $password User password
4599 * @return bool True if the given password is correct, otherwise False
4601 public function checkPassword( $password ) {
4602 wfDeprecated( __METHOD__
, '1.27' );
4604 $manager = AuthManager
::singleton();
4605 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4606 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4608 'username' => $this->getName(),
4609 'password' => $password,
4612 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4613 switch ( $res->status
) {
4614 case AuthenticationResponse
::PASS
:
4616 case AuthenticationResponse
::FAIL
:
4617 // Hope it's not a PreAuthenticationProvider that failed...
4618 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4619 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4622 throw new BadMethodCallException(
4623 'AuthManager returned a response unsupported by ' . __METHOD__
4629 * Check if the given clear-text password matches the temporary password
4630 * sent by e-mail for password reset operations.
4632 * @deprecated since 1.27, use AuthManager instead
4633 * @param string $plaintext
4634 * @return bool True if matches, false otherwise
4636 public function checkTemporaryPassword( $plaintext ) {
4637 wfDeprecated( __METHOD__
, '1.27' );
4638 // Can't check the temporary password individually.
4639 return $this->checkPassword( $plaintext );
4643 * Initialize (if necessary) and return a session token value
4644 * which can be used in edit forms to show that the user's
4645 * login credentials aren't being hijacked with a foreign form
4649 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4650 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4651 * @return MediaWiki\Session\Token The new edit token
4653 public function getEditTokenObject( $salt = '', $request = null ) {
4654 if ( $this->isAnon() ) {
4655 return new LoggedOutEditToken();
4659 $request = $this->getRequest();
4661 return $request->getSession()->getToken( $salt );
4665 * Initialize (if necessary) and return a session token value
4666 * which can be used in edit forms to show that the user's
4667 * login credentials aren't being hijacked with a foreign form
4670 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4673 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4674 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4675 * @return string The new edit token
4677 public function getEditToken( $salt = '', $request = null ) {
4678 return $this->getEditTokenObject( $salt, $request )->toString();
4682 * Check given value against the token value stored in the session.
4683 * A match should confirm that the form was submitted from the
4684 * user's own login session, not a form submission from a third-party
4687 * @param string $val Input value to compare
4688 * @param string|array $salt Optional function-specific data for hashing
4689 * @param WebRequest|null $request Object to use or null to use $wgRequest
4690 * @param int|null $maxage Fail tokens older than this, in seconds
4691 * @return bool Whether the token matches
4693 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4694 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4698 * Check given value against the token value stored in the session,
4699 * ignoring the suffix.
4701 * @param string $val Input value to compare
4702 * @param string|array $salt Optional function-specific data for hashing
4703 * @param WebRequest|null $request Object to use or null to use $wgRequest
4704 * @param int|null $maxage Fail tokens older than this, in seconds
4705 * @return bool Whether the token matches
4707 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4708 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4709 return $this->matchEditToken( $val, $salt, $request, $maxage );
4713 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4714 * mail to the user's given address.
4716 * @param string $type Message to send, either "created", "changed" or "set"
4719 public function sendConfirmationMail( $type = 'created' ) {
4721 $expiration = null; // gets passed-by-ref and defined in next line.
4722 $token = $this->confirmationToken( $expiration );
4723 $url = $this->confirmationTokenUrl( $token );
4724 $invalidateURL = $this->invalidationTokenUrl( $token );
4725 $this->saveSettings();
4727 if ( $type == 'created' ||
$type === false ) {
4728 $message = 'confirmemail_body';
4730 } elseif ( $type === true ) {
4731 $message = 'confirmemail_body_changed';
4734 // Messages: confirmemail_body_changed, confirmemail_body_set
4735 $message = 'confirmemail_body_' . $type;
4739 'subject' => wfMessage( 'confirmemail_subject' )->text(),
4740 'body' => wfMessage( $message,
4741 $this->getRequest()->getIP(),
4744 $wgLang->userTimeAndDate( $expiration, $this ),
4746 $wgLang->userDate( $expiration, $this ),
4747 $wgLang->userTime( $expiration, $this ) )->text(),
4753 'ip' => $this->getRequest()->getIP(),
4754 'confirmURL' => $url,
4755 'invalidateURL' => $invalidateURL,
4756 'expiration' => $expiration
4759 Hooks
::run( 'UserSendConfirmationMail', [ $this, &$mail, $info ] );
4760 return $this->sendMail( $mail['subject'], $mail['body'], $mail['from'], $mail['replyTo'] );
4764 * Send an e-mail to this user's account. Does not check for
4765 * confirmed status or validity.
4767 * @param string $subject Message subject
4768 * @param string $body Message body
4769 * @param User|null $from Optional sending user; if unspecified, default
4770 * $wgPasswordSender will be used.
4771 * @param MailAddress|null $replyto Reply-To address
4774 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4775 global $wgPasswordSender;
4777 if ( $from instanceof User
) {
4778 $sender = MailAddress
::newFromUser( $from );
4780 $sender = new MailAddress( $wgPasswordSender,
4781 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4783 $to = MailAddress
::newFromUser( $this );
4785 return UserMailer
::send( $to, $sender, $subject, $body, [
4786 'replyTo' => $replyto,
4791 * Generate, store, and return a new e-mail confirmation code.
4792 * A hash (unsalted, since it's used as a key) is stored.
4794 * @note Call saveSettings() after calling this function to commit
4795 * this change to the database.
4797 * @param string &$expiration Accepts the expiration time
4798 * @return string New token
4800 protected function confirmationToken( &$expiration ) {
4801 global $wgUserEmailConfirmationTokenExpiry;
4803 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4804 $expiration = wfTimestamp( TS_MW
, $expires );
4806 $token = MWCryptRand
::generateHex( 32 );
4807 $hash = md5( $token );
4808 $this->mEmailToken
= $hash;
4809 $this->mEmailTokenExpires
= $expiration;
4814 * Return a URL the user can use to confirm their email address.
4815 * @param string $token Accepts the email confirmation token
4816 * @return string New token URL
4818 protected function confirmationTokenUrl( $token ) {
4819 return $this->getTokenUrl( 'ConfirmEmail', $token );
4823 * Return a URL the user can use to invalidate their email address.
4824 * @param string $token Accepts the email confirmation token
4825 * @return string New token URL
4827 protected function invalidationTokenUrl( $token ) {
4828 return $this->getTokenUrl( 'InvalidateEmail', $token );
4832 * Internal function to format the e-mail validation/invalidation URLs.
4833 * This uses a quickie hack to use the
4834 * hardcoded English names of the Special: pages, for ASCII safety.
4836 * @note Since these URLs get dropped directly into emails, using the
4837 * short English names avoids insanely long URL-encoded links, which
4838 * also sometimes can get corrupted in some browsers/mailers
4839 * (T8957 with Gmail and Internet Explorer).
4841 * @param string $page Special page
4842 * @param string $token
4843 * @return string Formatted URL
4845 protected function getTokenUrl( $page, $token ) {
4846 // Hack to bypass localization of 'Special:'
4847 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4848 return $title->getCanonicalURL();
4852 * Mark the e-mail address confirmed.
4854 * @note Call saveSettings() after calling this function to commit the change.
4858 public function confirmEmail() {
4859 // Check if it's already confirmed, so we don't touch the database
4860 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4861 if ( !$this->isEmailConfirmed() ) {
4862 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4863 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4869 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4870 * address if it was already confirmed.
4872 * @note Call saveSettings() after calling this function to commit the change.
4873 * @return bool Returns true
4875 public function invalidateEmail() {
4877 $this->mEmailToken
= null;
4878 $this->mEmailTokenExpires
= null;
4879 $this->setEmailAuthenticationTimestamp( null );
4881 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4886 * Set the e-mail authentication timestamp.
4887 * @param string $timestamp TS_MW timestamp
4889 public function setEmailAuthenticationTimestamp( $timestamp ) {
4891 $this->mEmailAuthenticated
= $timestamp;
4892 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4896 * Is this user allowed to send e-mails within limits of current
4897 * site configuration?
4900 public function canSendEmail() {
4901 global $wgEnableEmail, $wgEnableUserEmail;
4902 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4905 $canSend = $this->isEmailConfirmed();
4906 // Avoid PHP 7.1 warning of passing $this by reference
4908 Hooks
::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
4913 * Is this user allowed to receive e-mails within limits of current
4914 * site configuration?
4917 public function canReceiveEmail() {
4918 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4922 * Is this user's e-mail address valid-looking and confirmed within
4923 * limits of the current site configuration?
4925 * @note If $wgEmailAuthentication is on, this may require the user to have
4926 * confirmed their address by returning a code or using a password
4927 * sent to the address from the wiki.
4931 public function isEmailConfirmed() {
4932 global $wgEmailAuthentication;
4934 // Avoid PHP 7.1 warning of passing $this by reference
4937 if ( Hooks
::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
4938 if ( $this->isAnon() ) {
4941 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4944 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4954 * Check whether there is an outstanding request for e-mail confirmation.
4957 public function isEmailConfirmationPending() {
4958 global $wgEmailAuthentication;
4959 return $wgEmailAuthentication &&
4960 !$this->isEmailConfirmed() &&
4961 $this->mEmailToken
&&
4962 $this->mEmailTokenExpires
> wfTimestamp();
4966 * Get the timestamp of account creation.
4968 * @return string|bool|null Timestamp of account creation, false for
4969 * non-existent/anonymous user accounts, or null if existing account
4970 * but information is not in database.
4972 public function getRegistration() {
4973 if ( $this->isAnon() ) {
4977 return $this->mRegistration
;
4981 * Get the timestamp of the first edit
4983 * @return string|bool Timestamp of first edit, or false for
4984 * non-existent/anonymous user accounts.
4986 public function getFirstEditTimestamp() {
4987 if ( $this->getId() == 0 ) {
4988 return false; // anons
4990 $dbr = wfGetDB( DB_REPLICA
);
4991 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
4992 $tsField = isset( $actorWhere['tables']['temp_rev_user'] )
4993 ?
'revactor_timestamp' : 'rev_timestamp';
4994 $time = $dbr->selectField(
4995 [ 'revision' ] +
$actorWhere['tables'],
4997 [ $actorWhere['conds'] ],
4999 [ 'ORDER BY' => "$tsField ASC" ],
5000 $actorWhere['joins']
5003 return false; // no edits
5005 return wfTimestamp( TS_MW
, $time );
5009 * Get the permissions associated with a given list of groups
5011 * @param array $groups Array of Strings List of internal group names
5012 * @return array Array of Strings List of permission key names for given groups combined
5014 public static function getGroupPermissions( $groups ) {
5015 global $wgGroupPermissions, $wgRevokePermissions;
5017 // grant every granted permission first
5018 foreach ( $groups as $group ) {
5019 if ( isset( $wgGroupPermissions[$group] ) ) {
5020 $rights = array_merge( $rights,
5021 // array_filter removes empty items
5022 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
5025 // now revoke the revoked permissions
5026 foreach ( $groups as $group ) {
5027 if ( isset( $wgRevokePermissions[$group] ) ) {
5028 $rights = array_diff( $rights,
5029 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
5032 return array_unique( $rights );
5036 * Get all the groups who have a given permission
5038 * @param string $role Role to check
5039 * @return array Array of Strings List of internal group names with the given permission
5041 public static function getGroupsWithPermission( $role ) {
5042 global $wgGroupPermissions;
5043 $allowedGroups = [];
5044 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
5045 if ( self
::groupHasPermission( $group, $role ) ) {
5046 $allowedGroups[] = $group;
5049 return $allowedGroups;
5053 * Check, if the given group has the given permission
5055 * If you're wanting to check whether all users have a permission, use
5056 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
5060 * @param string $group Group to check
5061 * @param string $role Role to check
5064 public static function groupHasPermission( $group, $role ) {
5065 global $wgGroupPermissions, $wgRevokePermissions;
5066 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
5067 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
5071 * Check if all users may be assumed to have the given permission
5073 * We generally assume so if the right is granted to '*' and isn't revoked
5074 * on any group. It doesn't attempt to take grants or other extension
5075 * limitations on rights into account in the general case, though, as that
5076 * would require it to always return false and defeat the purpose.
5077 * Specifically, session-based rights restrictions (such as OAuth or bot
5078 * passwords) are applied based on the current session.
5081 * @param string $right Right to check
5084 public static function isEveryoneAllowed( $right ) {
5085 global $wgGroupPermissions, $wgRevokePermissions;
5088 // Use the cached results, except in unit tests which rely on
5089 // being able change the permission mid-request
5090 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
5091 return $cache[$right];
5094 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
5095 $cache[$right] = false;
5099 // If it's revoked anywhere, then everyone doesn't have it
5100 foreach ( $wgRevokePermissions as $rights ) {
5101 if ( isset( $rights[$right] ) && $rights[$right] ) {
5102 $cache[$right] = false;
5107 // Remove any rights that aren't allowed to the global-session user,
5108 // unless there are no sessions for this endpoint.
5109 if ( !defined( 'MW_NO_SESSION' ) ) {
5110 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
5111 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
5112 $cache[$right] = false;
5117 // Allow extensions to say false
5118 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
5119 $cache[$right] = false;
5123 $cache[$right] = true;
5128 * Return the set of defined explicit groups.
5129 * The implicit groups (by default *, 'user' and 'autoconfirmed')
5130 * are not included, as they are defined automatically, not in the database.
5131 * @return array Array of internal group names
5133 public static function getAllGroups() {
5134 global $wgGroupPermissions, $wgRevokePermissions;
5135 return array_values( array_diff(
5136 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
5137 self
::getImplicitGroups()
5142 * Get a list of all available permissions.
5143 * @return string[] Array of permission names
5145 public static function getAllRights() {
5146 if ( self
::$mAllRights === false ) {
5147 global $wgAvailableRights;
5148 if ( count( $wgAvailableRights ) ) {
5149 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
5151 self
::$mAllRights = self
::$mCoreRights;
5153 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
5155 return self
::$mAllRights;
5159 * Get a list of implicit groups
5160 * TODO: Should we deprecate this? It's trivial, but we don't want to encourage use of globals.
5162 * @return array Array of Strings Array of internal group names
5164 public static function getImplicitGroups() {
5165 global $wgImplicitGroups;
5166 return $wgImplicitGroups;
5170 * Get the title of a page describing a particular group
5171 * @deprecated since 1.29 Use UserGroupMembership::getGroupPage instead
5173 * @param string $group Internal group name
5174 * @return Title|bool Title of the page if it exists, false otherwise
5176 public static function getGroupPage( $group ) {
5177 wfDeprecated( __METHOD__
, '1.29' );
5178 return UserGroupMembership
::getGroupPage( $group );
5182 * Create a link to the group in HTML, if available;
5183 * else return the group name.
5184 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5185 * make the link yourself if you need custom text
5187 * @param string $group Internal name of the group
5188 * @param string $text The text of the link
5189 * @return string HTML link to the group
5191 public static function makeGroupLinkHTML( $group, $text = '' ) {
5192 wfDeprecated( __METHOD__
, '1.29' );
5194 if ( $text == '' ) {
5195 $text = UserGroupMembership
::getGroupName( $group );
5197 $title = UserGroupMembership
::getGroupPage( $group );
5199 return MediaWikiServices
::getInstance()
5200 ->getLinkRenderer()->makeLink( $title, $text );
5203 return htmlspecialchars( $text );
5207 * Create a link to the group in Wikitext, if available;
5208 * else return the group name.
5209 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5210 * make the link yourself if you need custom text
5212 * @param string $group Internal name of the group
5213 * @param string $text The text of the link
5214 * @return string Wikilink to the group
5216 public static function makeGroupLinkWiki( $group, $text = '' ) {
5217 wfDeprecated( __METHOD__
, '1.29' );
5219 if ( $text == '' ) {
5220 $text = UserGroupMembership
::getGroupName( $group );
5222 $title = UserGroupMembership
::getGroupPage( $group );
5224 $page = $title->getFullText();
5225 return "[[$page|$text]]";
5232 * Returns an array of the groups that a particular group can add/remove.
5234 * @param string $group The group to check for whether it can add/remove
5235 * @return array Array( 'add' => array( addablegroups ),
5236 * 'remove' => array( removablegroups ),
5237 * 'add-self' => array( addablegroups to self),
5238 * 'remove-self' => array( removable groups from self) )
5240 public static function changeableByGroup( $group ) {
5241 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
5250 if ( empty( $wgAddGroups[$group] ) ) {
5251 // Don't add anything to $groups
5252 } elseif ( $wgAddGroups[$group] === true ) {
5253 // You get everything
5254 $groups['add'] = self
::getAllGroups();
5255 } elseif ( is_array( $wgAddGroups[$group] ) ) {
5256 $groups['add'] = $wgAddGroups[$group];
5259 // Same thing for remove
5260 if ( empty( $wgRemoveGroups[$group] ) ) {
5262 } elseif ( $wgRemoveGroups[$group] === true ) {
5263 $groups['remove'] = self
::getAllGroups();
5264 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
5265 $groups['remove'] = $wgRemoveGroups[$group];
5268 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
5269 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
5270 foreach ( $wgGroupsAddToSelf as $key => $value ) {
5271 if ( is_int( $key ) ) {
5272 $wgGroupsAddToSelf['user'][] = $value;
5277 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
5278 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
5279 if ( is_int( $key ) ) {
5280 $wgGroupsRemoveFromSelf['user'][] = $value;
5285 // Now figure out what groups the user can add to him/herself
5286 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
5288 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
5289 // No idea WHY this would be used, but it's there
5290 $groups['add-self'] = self
::getAllGroups();
5291 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
5292 $groups['add-self'] = $wgGroupsAddToSelf[$group];
5295 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
5297 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
5298 $groups['remove-self'] = self
::getAllGroups();
5299 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
5300 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
5307 * Returns an array of groups that this user can add and remove
5308 * @return array Array( 'add' => array( addablegroups ),
5309 * 'remove' => array( removablegroups ),
5310 * 'add-self' => array( addablegroups to self),
5311 * 'remove-self' => array( removable groups from self) )
5313 public function changeableGroups() {
5314 if ( $this->isAllowed( 'userrights' ) ) {
5315 // This group gives the right to modify everything (reverse-
5316 // compatibility with old "userrights lets you change
5318 // Using array_merge to make the groups reindexed
5319 $all = array_merge( self
::getAllGroups() );
5328 // Okay, it's not so simple, we will have to go through the arrays
5335 $addergroups = $this->getEffectiveGroups();
5337 foreach ( $addergroups as $addergroup ) {
5338 $groups = array_merge_recursive(
5339 $groups, $this->changeableByGroup( $addergroup )
5341 $groups['add'] = array_unique( $groups['add'] );
5342 $groups['remove'] = array_unique( $groups['remove'] );
5343 $groups['add-self'] = array_unique( $groups['add-self'] );
5344 $groups['remove-self'] = array_unique( $groups['remove-self'] );
5350 * Schedule a deferred update to update the user's edit count
5352 public function incEditCount() {
5353 if ( $this->isAnon() ) {
5357 DeferredUpdates
::addUpdate(
5358 new UserEditCountUpdate( $this, 1 ),
5359 DeferredUpdates
::POSTSEND
5364 * This method should not be called outside User/UserEditCountUpdate
5368 public function setEditCountInternal( $count ) {
5369 $this->mEditCount
= $count;
5373 * Initialize user_editcount from data out of the revision table
5375 * This method should not be called outside User/UserEditCountUpdate
5377 * @return int Number of edits
5379 public function initEditCountInternal() {
5380 // Pull from a replica DB to be less cruel to servers
5381 // Accuracy isn't the point anyway here
5382 $dbr = wfGetDB( DB_REPLICA
);
5383 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5384 $count = (int)$dbr->selectField(
5385 [ 'revision' ] +
$actorWhere['tables'],
5387 [ $actorWhere['conds'] ],
5390 $actorWhere['joins']
5393 $dbw = wfGetDB( DB_MASTER
);
5396 [ 'user_editcount' => $count ],
5398 'user_id' => $this->getId(),
5399 'user_editcount IS NULL OR user_editcount < ' . (int)$count
5408 * Get the description of a given right
5411 * @param string $right Right to query
5412 * @return string Localized description of the right
5414 public static function getRightDescription( $right ) {
5415 $key = "right-$right";
5416 $msg = wfMessage( $key );
5417 return $msg->isDisabled() ?
$right : $msg->text();
5421 * Get the name of a given grant
5424 * @param string $grant Grant to query
5425 * @return string Localized name of the grant
5427 public static function getGrantName( $grant ) {
5428 $key = "grant-$grant";
5429 $msg = wfMessage( $key );
5430 return $msg->isDisabled() ?
$grant : $msg->text();
5434 * Add a newuser log entry for this user.
5435 * Before 1.19 the return value was always true.
5437 * @deprecated since 1.27, AuthManager handles logging
5438 * @param string|bool $action Account creation type.
5439 * - String, one of the following values:
5440 * - 'create' for an anonymous user creating an account for himself.
5441 * This will force the action's performer to be the created user itself,
5442 * no matter the value of $wgUser
5443 * - 'create2' for a logged in user creating an account for someone else
5444 * - 'byemail' when the created user will receive its password by e-mail
5445 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5446 * - Boolean means whether the account was created by e-mail (deprecated):
5447 * - true will be converted to 'byemail'
5448 * - false will be converted to 'create' if this object is the same as
5449 * $wgUser and to 'create2' otherwise
5450 * @param string $reason User supplied reason
5453 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5454 return true; // disabled
5458 * Add an autocreate newuser log entry for this user
5459 * Used by things like CentralAuth and perhaps other authplugins.
5460 * Consider calling addNewUserLogEntry() directly instead.
5462 * @deprecated since 1.27, AuthManager handles logging
5465 public function addNewUserLogEntryAutoCreate() {
5466 $this->addNewUserLogEntry( 'autocreate' );
5472 * Load the user options either from cache, the database or an array
5474 * @param array|null $data Rows for the current user out of the user_properties table
5476 protected function loadOptions( $data = null ) {
5479 if ( $this->mOptionsLoaded
) {
5483 $this->mOptions
= self
::getDefaultOptions();
5485 if ( !$this->getId() ) {
5486 // For unlogged-in users, load language/variant options from request.
5487 // There's no need to do it for logged-in users: they can set preferences,
5488 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5489 // so don't override user's choice (especially when the user chooses site default).
5490 $variant = MediaWikiServices
::getInstance()->getContentLanguage()->getDefaultVariant();
5491 $this->mOptions
['variant'] = $variant;
5492 $this->mOptions
['language'] = $variant;
5493 $this->mOptionsLoaded
= true;
5497 // Maybe load from the object
5498 if ( !is_null( $this->mOptionOverrides
) ) {
5499 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5500 foreach ( $this->mOptionOverrides
as $key => $value ) {
5501 $this->mOptions
[$key] = $value;
5504 if ( !is_array( $data ) ) {
5505 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5506 // Load from database
5507 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5508 ?
wfGetDB( DB_MASTER
)
5509 : wfGetDB( DB_REPLICA
);
5511 $res = $dbr->select(
5513 [ 'up_property', 'up_value' ],
5514 [ 'up_user' => $this->getId() ],
5518 $this->mOptionOverrides
= [];
5520 foreach ( $res as $row ) {
5521 // Convert '0' to 0. PHP's boolean conversion considers them both
5522 // false, but e.g. JavaScript considers the former as true.
5523 // @todo: T54542 Somehow determine the desired type (string/int/bool)
5524 // and convert all values here.
5525 if ( $row->up_value
=== '0' ) {
5528 $data[$row->up_property
] = $row->up_value
;
5532 foreach ( $data as $property => $value ) {
5533 $this->mOptionOverrides
[$property] = $value;
5534 $this->mOptions
[$property] = $value;
5538 // Replace deprecated language codes
5539 $this->mOptions
['language'] = LanguageCode
::replaceDeprecatedCodes(
5540 $this->mOptions
['language']
5543 $this->mOptionsLoaded
= true;
5545 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5549 * Saves the non-default options for this user, as previously set e.g. via
5550 * setOption(), in the database's "user_properties" (preferences) table.
5551 * Usually used via saveSettings().
5553 protected function saveOptions() {
5554 $this->loadOptions();
5556 // Not using getOptions(), to keep hidden preferences in database
5557 $saveOptions = $this->mOptions
;
5559 // Allow hooks to abort, for instance to save to a global profile.
5560 // Reset options to default state before saving.
5561 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5565 $userId = $this->getId();
5567 $insert_rows = []; // all the new preference rows
5568 foreach ( $saveOptions as $key => $value ) {
5569 // Don't bother storing default values
5570 $defaultOption = self
::getDefaultOption( $key );
5571 if ( ( $defaultOption === null && $value !== false && $value !== null )
5572 ||
$value != $defaultOption
5575 'up_user' => $userId,
5576 'up_property' => $key,
5577 'up_value' => $value,
5582 $dbw = wfGetDB( DB_MASTER
);
5584 $res = $dbw->select( 'user_properties',
5585 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5587 // Find prior rows that need to be removed or updated. These rows will
5588 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5590 foreach ( $res as $row ) {
5591 if ( !isset( $saveOptions[$row->up_property
] )
5592 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5594 $keysDelete[] = $row->up_property
;
5598 if ( count( $keysDelete ) ) {
5599 // Do the DELETE by PRIMARY KEY for prior rows.
5600 // In the past a very large portion of calls to this function are for setting
5601 // 'rememberpassword' for new accounts (a preference that has since been removed).
5602 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5603 // caused gap locks on [max user ID,+infinity) which caused high contention since
5604 // updates would pile up on each other as they are for higher (newer) user IDs.
5605 // It might not be necessary these days, but it shouldn't hurt either.
5606 $dbw->delete( 'user_properties',
5607 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5609 // Insert the new preference rows
5610 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5614 * Return the list of user fields that should be selected to create
5615 * a new user object.
5616 * @deprecated since 1.31, use self::getQueryInfo() instead.
5619 public static function selectFields() {
5620 wfDeprecated( __METHOD__
, '1.31' );
5628 'user_email_authenticated',
5630 'user_email_token_expires',
5631 'user_registration',
5637 * Return the tables, fields, and join conditions to be selected to create
5638 * a new user object.
5640 * @return array With three keys:
5641 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
5642 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
5643 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
5645 public static function getQueryInfo() {
5646 global $wgActorTableSchemaMigrationStage;
5649 'tables' => [ 'user' ],
5657 'user_email_authenticated',
5659 'user_email_token_expires',
5660 'user_registration',
5666 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
5667 // but it does little harm and might be needed for write callers loading a User.
5668 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
5669 $ret['tables']['user_actor'] = 'actor';
5670 $ret['fields'][] = 'user_actor.actor_id';
5671 $ret['joins']['user_actor'] = [
5672 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) ?
'JOIN' : 'LEFT JOIN',
5673 [ 'user_actor.actor_user = user_id' ]
5681 * Factory function for fatal permission-denied errors
5684 * @param string $permission User right required
5687 static function newFatalPermissionDeniedStatus( $permission ) {
5691 foreach ( self
::getGroupsWithPermission( $permission ) as $group ) {
5692 $groups[] = UserGroupMembership
::getLink( $group, RequestContext
::getMain(), 'wiki' );
5696 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5699 return Status
::newFatal( 'badaccess-group0' );
5703 * Get a new instance of this user that was loaded from the master via a locking read
5705 * Use this instead of the main context User when updating that user. This avoids races
5706 * where that user was loaded from a replica DB or even the master but without proper locks.
5708 * @return User|null Returns null if the user was not found in the DB
5711 public function getInstanceForUpdate() {
5712 if ( !$this->getId() ) {
5713 return null; // anon
5716 $user = self
::newFromId( $this->getId() );
5717 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5725 * Checks if two user objects point to the same user.
5727 * @since 1.25 ; takes a UserIdentity instead of a User since 1.32
5728 * @param UserIdentity $user
5731 public function equals( UserIdentity
$user ) {
5732 // XXX it's not clear whether central ID providers are supposed to obey this
5733 return $this->getName() === $user->getName();