3 * Implements the User class for the %MediaWiki software.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\MediaWikiServices
;
24 use MediaWiki\Session\SessionManager
;
25 use MediaWiki\Session\Token
;
26 use MediaWiki\Auth\AuthManager
;
27 use MediaWiki\Auth\AuthenticationResponse
;
28 use MediaWiki\Auth\AuthenticationRequest
;
29 use MediaWiki\User\UserIdentity
;
30 use MediaWiki\Logger\LoggerFactory
;
32 use Wikimedia\ScopedCallback
;
33 use Wikimedia\Rdbms\Database
;
34 use Wikimedia\Rdbms\DBExpectedError
;
35 use Wikimedia\Rdbms\IDatabase
;
38 * The User object encapsulates all of the user-specific settings (user_id,
39 * name, rights, email address, options, last login time). Client
40 * classes use the getXXX() functions to access these fields. These functions
41 * do all the work of determining whether the user is logged in,
42 * whether the requested option can be satisfied from cookies or
43 * whether a database query is needed. Most of the settings needed
44 * for rendering normal pages are set in the cookie to minimize use
47 class User
implements IDBAccessObject
, UserIdentity
{
49 * @const int Number of characters in user_token field.
51 const TOKEN_LENGTH
= 32;
54 * @const string An invalid value for user_token
56 const INVALID_TOKEN
= '*** INVALID ***';
59 * @const int Serialized record version.
64 * Exclude user options that are set to their default value.
67 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
72 const CHECK_USER_RIGHTS
= true;
77 const IGNORE_USER_RIGHTS
= false;
80 * Array of Strings List of member variables which are saved to the
81 * shared cache (memcached). Any operation which changes the
82 * corresponding database fields must call a cache-clearing function.
85 protected static $mCacheVars = [
93 'mEmailAuthenticated',
100 // user_properties table
107 * Array of Strings Core rights.
108 * Each of these should have a corresponding message of the form
112 protected static $mCoreRights = [
160 'move-categorypages',
161 'move-rootuserpages',
165 'override-export-depth',
187 'userrights-interwiki',
195 * String Cached results of getAllRights()
197 protected static $mAllRights = false;
199 /** Cache variables */
212 /** @var string TS_MW timestamp from the DB */
214 /** @var string TS_MW timestamp from cache */
215 protected $mQuickTouched;
219 public $mEmailAuthenticated;
221 protected $mEmailToken;
223 protected $mEmailTokenExpires;
225 protected $mRegistration;
227 protected $mEditCount;
228 /** @var UserGroupMembership[] Associative array of (group name => UserGroupMembership object) */
229 protected $mGroupMemberships;
231 protected $mOptionOverrides;
235 * Bool Whether the cache variables have been loaded.
238 public $mOptionsLoaded;
241 * Array with already loaded items or true if all items have been loaded.
243 protected $mLoadedItems = [];
247 * String Initialization data source if mLoadedItems!==true. May be one of:
248 * - 'defaults' anonymous user initialised from class defaults
249 * - 'name' initialise from mName
250 * - 'id' initialise from mId
251 * - 'actor' initialise from mActorId
252 * - 'session' log in from session if possible
254 * Use the User::newFrom*() family of functions to set this.
259 * Lazy-initialized variables, invalidated with clearInstanceCache
263 protected $mDatePreference;
271 protected $mBlockreason;
273 protected $mEffectiveGroups;
275 protected $mImplicitGroups;
277 protected $mFormerGroups;
279 protected $mGlobalBlock;
287 /** @var WebRequest */
294 protected $mAllowUsertalk;
297 private $mBlockedFromCreateAccount = false;
299 /** @var int User::READ_* constant bitfield used to load data */
300 protected $queryFlagsUsed = self
::READ_NORMAL
;
302 public static $idCacheByName = [];
305 * Lightweight constructor for an anonymous user.
306 * Use the User::newFrom* factory functions for other kinds of users.
310 * @see newFromActorId()
311 * @see newFromConfirmationCode()
312 * @see newFromSession()
315 public function __construct() {
316 $this->clearInstanceCache( 'defaults' );
322 public function __toString() {
323 return (string)$this->getName();
327 * Test if it's safe to load this User object.
329 * You should typically check this before using $wgUser or
330 * RequestContext::getUser in a method that might be called before the
331 * system has been fully initialized. If the object is unsafe, you should
332 * use an anonymous user:
334 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
340 public function isSafeToLoad() {
341 global $wgFullyInitialised;
343 // The user is safe to load if:
344 // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
345 // * mLoadedItems === true (already loaded)
346 // * mFrom !== 'session' (sessions not involved at all)
348 return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
349 $this->mLoadedItems
=== true ||
$this->mFrom
!== 'session';
353 * Load the user table data for this object from the source given by mFrom.
355 * @param int $flags User::READ_* constant bitfield
357 public function load( $flags = self
::READ_NORMAL
) {
358 global $wgFullyInitialised;
360 if ( $this->mLoadedItems
=== true ) {
364 // Set it now to avoid infinite recursion in accessors
365 $oldLoadedItems = $this->mLoadedItems
;
366 $this->mLoadedItems
= true;
367 $this->queryFlagsUsed
= $flags;
369 // If this is called too early, things are likely to break.
370 if ( !$wgFullyInitialised && $this->mFrom
=== 'session' ) {
371 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
372 ->warning( 'User::loadFromSession called before the end of Setup.php', [
373 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
375 $this->loadDefaults();
376 $this->mLoadedItems
= $oldLoadedItems;
380 switch ( $this->mFrom
) {
382 $this->loadDefaults();
385 // Make sure this thread sees its own changes
386 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
387 if ( $lb->hasOrMadeRecentMasterChanges() ) {
388 $flags |
= self
::READ_LATEST
;
389 $this->queryFlagsUsed
= $flags;
392 $this->mId
= self
::idFromName( $this->mName
, $flags );
394 // Nonexistent user placeholder object
395 $this->loadDefaults( $this->mName
);
397 $this->loadFromId( $flags );
401 // Make sure this thread sees its own changes, if the ID isn't 0
402 if ( $this->mId
!= 0 ) {
403 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
404 if ( $lb->hasOrMadeRecentMasterChanges() ) {
405 $flags |
= self
::READ_LATEST
;
406 $this->queryFlagsUsed
= $flags;
410 $this->loadFromId( $flags );
413 // Make sure this thread sees its own changes
414 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
415 if ( $lb->hasOrMadeRecentMasterChanges() ) {
416 $flags |
= self
::READ_LATEST
;
417 $this->queryFlagsUsed
= $flags;
420 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
421 $row = wfGetDB( $index )->selectRow(
423 [ 'actor_user', 'actor_name' ],
424 [ 'actor_id' => $this->mActorId
],
431 $this->loadDefaults();
432 } elseif ( $row->actor_user
) {
433 $this->mId
= $row->actor_user
;
434 $this->loadFromId( $flags );
436 $this->loadDefaults( $row->actor_name
);
440 if ( !$this->loadFromSession() ) {
441 // Loading from session failed. Load defaults.
442 $this->loadDefaults();
444 Hooks
::run( 'UserLoadAfterLoadFromSession', [ $this ] );
447 throw new UnexpectedValueException(
448 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
453 * Load user table data, given mId has already been set.
454 * @param int $flags User::READ_* constant bitfield
455 * @return bool False if the ID does not exist, true otherwise
457 public function loadFromId( $flags = self
::READ_NORMAL
) {
458 if ( $this->mId
== 0 ) {
459 // Anonymous users are not in the database (don't need cache)
460 $this->loadDefaults();
464 // Try cache (unless this needs data from the master DB).
465 // NOTE: if this thread called saveSettings(), the cache was cleared.
466 $latest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
468 if ( !$this->loadFromDatabase( $flags ) ) {
469 // Can't load from ID
473 $this->loadFromCache();
476 $this->mLoadedItems
= true;
477 $this->queryFlagsUsed
= $flags;
484 * @param string $wikiId
487 public static function purge( $wikiId, $userId ) {
488 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
489 $key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
490 $cache->delete( $key );
495 * @param WANObjectCache $cache
498 protected function getCacheKey( WANObjectCache
$cache ) {
499 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
501 return $cache->makeGlobalKey( 'user', 'id', $lbFactory->getLocalDomainID(), $this->mId
);
505 * @param WANObjectCache $cache
509 public function getMutableCacheKeys( WANObjectCache
$cache ) {
510 $id = $this->getId();
512 return $id ?
[ $this->getCacheKey( $cache ) ] : [];
516 * Load user data from shared cache, given mId has already been set.
521 protected function loadFromCache() {
522 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
523 $data = $cache->getWithSetCallback(
524 $this->getCacheKey( $cache ),
526 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
527 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
528 wfDebug( "User: cache miss for user {$this->mId}\n" );
530 $this->loadFromDatabase( self
::READ_NORMAL
);
532 $this->loadOptions();
535 foreach ( self
::$mCacheVars as $name ) {
536 $data[$name] = $this->$name;
539 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->mTouched
), $ttl );
541 // if a user group membership is about to expire, the cache needs to
542 // expire at that time (T163691)
543 foreach ( $this->mGroupMemberships
as $ugm ) {
544 if ( $ugm->getExpiry() ) {
545 $secondsUntilExpiry = wfTimestamp( TS_UNIX
, $ugm->getExpiry() ) - time();
546 if ( $secondsUntilExpiry > 0 && $secondsUntilExpiry < $ttl ) {
547 $ttl = $secondsUntilExpiry;
554 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'version' => self
::VERSION
]
557 // Restore from cache
558 foreach ( self
::$mCacheVars as $name ) {
559 $this->$name = $data[$name];
565 /** @name newFrom*() static factory methods */
569 * Static factory method for creation from username.
571 * This is slightly less efficient than newFromId(), so use newFromId() if
572 * you have both an ID and a name handy.
574 * @param string $name Username, validated by Title::newFromText()
575 * @param string|bool $validate Validate username. Takes the same parameters as
576 * User::getCanonicalName(), except that true is accepted as an alias
577 * for 'valid', for BC.
579 * @return User|bool User object, or false if the username is invalid
580 * (e.g. if it contains illegal characters or is an IP address). If the
581 * username is not present in the database, the result will be a user object
582 * with a name, zero user ID and default settings.
584 public static function newFromName( $name, $validate = 'valid' ) {
585 if ( $validate === true ) {
588 $name = self
::getCanonicalName( $name, $validate );
589 if ( $name === false ) {
593 // Create unloaded user object
597 $u->setItemLoaded( 'name' );
603 * Static factory method for creation from a given user ID.
605 * @param int $id Valid user ID
606 * @return User The corresponding User object
608 public static function newFromId( $id ) {
612 $u->setItemLoaded( 'id' );
617 * Static factory method for creation from a given actor ID.
620 * @param int $id Valid actor ID
621 * @return User The corresponding User object
623 public static function newFromActorId( $id ) {
624 global $wgActorTableSchemaMigrationStage;
626 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
627 // but it does little harm and might be needed for write callers loading a User.
628 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) ) {
629 throw new BadMethodCallException(
630 'Cannot use ' . __METHOD__
631 . ' when $wgActorTableSchemaMigrationStage lacks SCHEMA_COMPAT_NEW'
638 $u->setItemLoaded( 'actor' );
643 * Returns a User object corresponding to the given UserIdentity.
647 * @param UserIdentity $identity
651 public static function newFromIdentity( UserIdentity
$identity ) {
652 if ( $identity instanceof User
) {
656 return self
::newFromAnyId(
657 $identity->getId() === 0 ?
null : $identity->getId(),
658 $identity->getName() === '' ?
null : $identity->getName(),
659 $identity->getActorId() === 0 ?
null : $identity->getActorId()
664 * Static factory method for creation from an ID, name, and/or actor ID
666 * This does not check that the ID, name, and actor ID all correspond to
670 * @param int|null $userId User ID, if known
671 * @param string|null $userName User name, if known
672 * @param int|null $actorId Actor ID, if known
675 public static function newFromAnyId( $userId, $userName, $actorId ) {
676 global $wgActorTableSchemaMigrationStage;
679 $user->mFrom
= 'defaults';
681 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
682 // but it does little harm and might be needed for write callers loading a User.
683 if ( ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) && $actorId !== null ) {
684 $user->mActorId
= (int)$actorId;
685 if ( $user->mActorId
!== 0 ) {
686 $user->mFrom
= 'actor';
688 $user->setItemLoaded( 'actor' );
691 if ( $userName !== null && $userName !== '' ) {
692 $user->mName
= $userName;
693 $user->mFrom
= 'name';
694 $user->setItemLoaded( 'name' );
697 if ( $userId !== null ) {
698 $user->mId
= (int)$userId;
699 if ( $user->mId
!== 0 ) {
702 $user->setItemLoaded( 'id' );
705 if ( $user->mFrom
=== 'defaults' ) {
706 throw new InvalidArgumentException(
707 'Cannot create a user with no name, no ID, and no actor ID'
715 * Factory method to fetch whichever user has a given email confirmation code.
716 * This code is generated when an account is created or its e-mail address
719 * If the code is invalid or has expired, returns NULL.
721 * @param string $code Confirmation code
722 * @param int $flags User::READ_* bitfield
725 public static function newFromConfirmationCode( $code, $flags = 0 ) {
726 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
727 ?
wfGetDB( DB_MASTER
)
728 : wfGetDB( DB_REPLICA
);
730 $id = $db->selectField(
734 'user_email_token' => md5( $code ),
735 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
739 return $id ? self
::newFromId( $id ) : null;
743 * Create a new user object using data from session. If the login
744 * credentials are invalid, the result is an anonymous user.
746 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
749 public static function newFromSession( WebRequest
$request = null ) {
751 $user->mFrom
= 'session';
752 $user->mRequest
= $request;
757 * Create a new user object from a user row.
758 * The row should have the following fields from the user table in it:
759 * - either user_name or user_id to load further data if needed (or both)
761 * - all other fields (email, etc.)
762 * It is useless to provide the remaining fields if either user_id,
763 * user_name and user_real_name are not provided because the whole row
764 * will be loaded once more from the database when accessing them.
766 * @param stdClass $row A row from the user table
767 * @param array|null $data Further data to load into the object
768 * (see User::loadFromRow for valid keys)
771 public static function newFromRow( $row, $data = null ) {
773 $user->loadFromRow( $row, $data );
778 * Static factory method for creation of a "system" user from username.
780 * A "system" user is an account that's used to attribute logged actions
781 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
782 * might include the 'Maintenance script' or 'Conversion script' accounts
783 * used by various scripts in the maintenance/ directory or accounts such
784 * as 'MediaWiki message delivery' used by the MassMessage extension.
786 * This can optionally create the user if it doesn't exist, and "steal" the
787 * account if it does exist.
789 * "Stealing" an existing user is intended to make it impossible for normal
790 * authentication processes to use the account, effectively disabling the
791 * account for normal use:
792 * - Email is invalidated, to prevent account recovery by emailing a
793 * temporary password and to disassociate the account from the existing
795 * - The token is set to a magic invalid value, to kill existing sessions
796 * and to prevent $this->setToken() calls from resetting the token to a
798 * - SessionManager is instructed to prevent new sessions for the user, to
799 * do things like deauthorizing OAuth consumers.
800 * - AuthManager is instructed to revoke access, to invalidate or remove
801 * passwords and other credentials.
803 * @param string $name Username
804 * @param array $options Options are:
805 * - validate: As for User::getCanonicalName(), default 'valid'
806 * - create: Whether to create the user if it doesn't already exist, default true
807 * - steal: Whether to "disable" the account for normal use if it already
808 * exists, default false
812 public static function newSystemUser( $name, $options = [] ) {
814 'validate' => 'valid',
819 $name = self
::getCanonicalName( $name, $options['validate'] );
820 if ( $name === false ) {
824 $dbr = wfGetDB( DB_REPLICA
);
825 $userQuery = self
::getQueryInfo();
826 $row = $dbr->selectRow(
827 $userQuery['tables'],
828 $userQuery['fields'],
829 [ 'user_name' => $name ],
835 // Try the master database...
836 $dbw = wfGetDB( DB_MASTER
);
837 $row = $dbw->selectRow(
838 $userQuery['tables'],
839 $userQuery['fields'],
840 [ 'user_name' => $name ],
848 // No user. Create it?
849 return $options['create']
850 ? self
::createNew( $name, [ 'token' => self
::INVALID_TOKEN
] )
854 $user = self
::newFromRow( $row );
856 // A user is considered to exist as a non-system user if it can
857 // authenticate, or has an email set, or has a non-invalid token.
858 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
859 AuthManager
::singleton()->userCanAuthenticate( $name )
861 // User exists. Steal it?
862 if ( !$options['steal'] ) {
866 AuthManager
::singleton()->revokeAccessForUser( $name );
868 $user->invalidateEmail();
869 $user->mToken
= self
::INVALID_TOKEN
;
870 $user->saveSettings();
871 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
880 * Get the username corresponding to a given user ID
881 * @param int $id User ID
882 * @return string|bool The corresponding username
884 public static function whoIs( $id ) {
885 return UserCache
::singleton()->getProp( $id, 'name' );
889 * Get the real name of a user given their user ID
891 * @param int $id User ID
892 * @return string|bool The corresponding user's real name
894 public static function whoIsReal( $id ) {
895 return UserCache
::singleton()->getProp( $id, 'real_name' );
899 * Get database id given a user name
900 * @param string $name Username
901 * @param int $flags User::READ_* constant bitfield
902 * @return int|null The corresponding user's ID, or null if user is nonexistent
904 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
905 // Don't explode on self::$idCacheByName[$name] if $name is not a string but e.g. a User object
906 $name = (string)$name;
907 $nt = Title
::makeTitleSafe( NS_USER
, $name );
908 if ( is_null( $nt ) ) {
913 if ( !( $flags & self
::READ_LATEST
) && array_key_exists( $name, self
::$idCacheByName ) ) {
914 return self
::$idCacheByName[$name];
917 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
918 $db = wfGetDB( $index );
923 [ 'user_name' => $nt->getText() ],
928 if ( $s === false ) {
931 $result = (int)$s->user_id
;
934 self
::$idCacheByName[$name] = $result;
936 if ( count( self
::$idCacheByName ) > 1000 ) {
937 self
::$idCacheByName = [];
944 * Reset the cache used in idFromName(). For use in tests.
946 public static function resetIdByNameCache() {
947 self
::$idCacheByName = [];
951 * Does the string match an anonymous IP address?
953 * This function exists for username validation, in order to reject
954 * usernames which are similar in form to IP addresses. Strings such
955 * as 300.300.300.300 will return true because it looks like an IP
956 * address, despite not being strictly valid.
958 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
959 * address because the usemod software would "cloak" anonymous IP
960 * addresses like this, if we allowed accounts like this to be created
961 * new users could get the old edits of these anonymous users.
963 * @param string $name Name to match
966 public static function isIP( $name ) {
967 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
968 || IP
::isIPv6( $name );
972 * Is the user an IP range?
977 public function isIPRange() {
978 return IP
::isValidRange( $this->mName
);
982 * Is the input a valid username?
984 * Checks if the input is a valid username, we don't want an empty string,
985 * an IP address, anything that contains slashes (would mess up subpages),
986 * is longer than the maximum allowed username size or doesn't begin with
989 * @param string $name Name to match
992 public static function isValidUserName( $name ) {
993 global $wgMaxNameChars;
996 || self
::isIP( $name )
997 ||
strpos( $name, '/' ) !== false
998 ||
strlen( $name ) > $wgMaxNameChars
999 ||
$name != MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name )
1004 // Ensure that the name can't be misresolved as a different title,
1005 // such as with extra namespace keys at the start.
1006 $parsed = Title
::newFromText( $name );
1007 if ( is_null( $parsed )
1008 ||
$parsed->getNamespace()
1009 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
1013 // Check an additional blacklist of troublemaker characters.
1014 // Should these be merged into the title char list?
1015 $unicodeBlacklist = '/[' .
1016 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
1017 '\x{00a0}' . # non-breaking space
1018 '\x{2000}-\x{200f}' . # various whitespace
1019 '\x{2028}-\x{202f}' . # breaks and control chars
1020 '\x{3000}' . # ideographic space
1021 '\x{e000}-\x{f8ff}' . # private use
1023 if ( preg_match( $unicodeBlacklist, $name ) ) {
1031 * Usernames which fail to pass this function will be blocked
1032 * from user login and new account registrations, but may be used
1033 * internally by batch processes.
1035 * If an account already exists in this form, login will be blocked
1036 * by a failure to pass this function.
1038 * @param string $name Name to match
1041 public static function isUsableName( $name ) {
1042 global $wgReservedUsernames;
1043 // Must be a valid username, obviously ;)
1044 if ( !self
::isValidUserName( $name ) ) {
1048 static $reservedUsernames = false;
1049 if ( !$reservedUsernames ) {
1050 $reservedUsernames = $wgReservedUsernames;
1051 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
1054 // Certain names may be reserved for batch processes.
1055 foreach ( $reservedUsernames as $reserved ) {
1056 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
1057 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->plain();
1059 if ( $reserved == $name ) {
1067 * Return the users who are members of the given group(s). In case of multiple groups,
1068 * users who are members of at least one of them are returned.
1070 * @param string|array $groups A single group name or an array of group names
1071 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
1072 * records; larger values are ignored.
1073 * @param int|null $after ID the user to start after
1074 * @return UserArrayFromResult
1076 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
1077 if ( $groups === [] ) {
1078 return UserArrayFromResult
::newFromIDs( [] );
1081 $groups = array_unique( (array)$groups );
1082 $limit = min( 5000, $limit );
1084 $conds = [ 'ug_group' => $groups ];
1085 if ( $after !== null ) {
1086 $conds[] = 'ug_user > ' . (int)$after;
1089 $dbr = wfGetDB( DB_REPLICA
);
1090 $ids = $dbr->selectFieldValues(
1097 'ORDER BY' => 'ug_user',
1101 return UserArray
::newFromIDs( $ids );
1105 * Usernames which fail to pass this function will be blocked
1106 * from new account registrations, but may be used internally
1107 * either by batch processes or by user accounts which have
1108 * already been created.
1110 * Additional blacklisting may be added here rather than in
1111 * isValidUserName() to avoid disrupting existing accounts.
1113 * @param string $name String to match
1116 public static function isCreatableName( $name ) {
1117 global $wgInvalidUsernameCharacters;
1119 // Ensure that the username isn't longer than 235 bytes, so that
1120 // (at least for the builtin skins) user javascript and css files
1121 // will work. (T25080)
1122 if ( strlen( $name ) > 235 ) {
1123 wfDebugLog( 'username', __METHOD__
.
1124 ": '$name' invalid due to length" );
1128 // Preg yells if you try to give it an empty string
1129 if ( $wgInvalidUsernameCharacters !== '' &&
1130 preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name )
1132 wfDebugLog( 'username', __METHOD__
.
1133 ": '$name' invalid due to wgInvalidUsernameCharacters" );
1137 return self
::isUsableName( $name );
1141 * Is the input a valid password for this user?
1143 * @param string $password Desired password
1146 public function isValidPassword( $password ) {
1147 // simple boolean wrapper for checkPasswordValidity
1148 return $this->checkPasswordValidity( $password )->isGood();
1152 * Given unvalidated password input, return error message on failure.
1154 * @param string $password Desired password
1155 * @return bool|string|array True on success, string or array of error message on failure
1156 * @deprecated since 1.33, use checkPasswordValidity
1158 public function getPasswordValidity( $password ) {
1159 wfDeprecated( __METHOD__
, '1.33' );
1161 $result = $this->checkPasswordValidity( $password );
1162 if ( $result->isGood() ) {
1167 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
1168 $messages[] = $error['message'];
1170 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
1171 $messages[] = $warning['message'];
1173 if ( count( $messages ) === 1 ) {
1174 return $messages[0];
1181 * Check if this is a valid password for this user
1183 * Returns a Status object with a set of messages describing
1184 * problems with the password. If the return status is fatal,
1185 * the action should be refused and the password should not be
1186 * checked at all (this is mainly meant for DoS mitigation).
1187 * If the return value is OK but not good, the password can be checked,
1188 * but the user should not be able to set their password to this.
1189 * The value of the returned Status object will be an array which
1190 * can have the following fields:
1191 * - forceChange (bool): if set to true, the user should not be
1192 * allowed to log with this password unless they change it during
1193 * the login process (see ResetPasswordSecondaryAuthenticationProvider).
1194 * - suggestChangeOnLogin (bool): if set to true, the user should be prompted for
1195 * a password change on login.
1197 * @param string $password Desired password
1201 public function checkPasswordValidity( $password ) {
1202 global $wgPasswordPolicy;
1204 $upp = new UserPasswordPolicy(
1205 $wgPasswordPolicy['policies'],
1206 $wgPasswordPolicy['checks']
1209 $status = Status
::newGood( [] );
1210 $result = false; // init $result to false for the internal checks
1212 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1213 $status->error( $result );
1217 if ( $result === false ) {
1218 $status->merge( $upp->checkUserPassword( $this, $password ), true );
1222 if ( $result === true ) {
1226 $status->error( $result );
1227 return $status; // the isValidPassword hook set a string $result and returned true
1231 * Given unvalidated user input, return a canonical username, or false if
1232 * the username is invalid.
1233 * @param string $name User input
1234 * @param string|bool $validate Type of validation to use:
1235 * - false No validation
1236 * - 'valid' Valid for batch processes
1237 * - 'usable' Valid for batch processes and login
1238 * - 'creatable' Valid for batch processes, login and account creation
1240 * @throws InvalidArgumentException
1241 * @return bool|string
1243 public static function getCanonicalName( $name, $validate = 'valid' ) {
1244 // Force usernames to capital
1245 $name = MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name );
1247 # Reject names containing '#'; these will be cleaned up
1248 # with title normalisation, but then it's too late to
1250 if ( strpos( $name, '#' ) !== false ) {
1254 // Clean up name according to title rules,
1255 // but only when validation is requested (T14654)
1256 $t = ( $validate !== false ) ?
1257 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1258 // Check for invalid titles
1259 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1263 $name = $t->getText();
1265 switch ( $validate ) {
1269 if ( !self
::isValidUserName( $name ) ) {
1274 if ( !self
::isUsableName( $name ) ) {
1279 if ( !self
::isCreatableName( $name ) ) {
1284 throw new InvalidArgumentException(
1285 'Invalid parameter value for $validate in ' . __METHOD__
);
1291 * Return a random password.
1293 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1294 * @return string New random password
1296 public static function randomPassword() {
1297 global $wgMinimalPasswordLength;
1298 return PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1302 * Set cached properties to default.
1304 * @note This no longer clears uncached lazy-initialised properties;
1305 * the constructor does that instead.
1307 * @param string|bool $name
1309 public function loadDefaults( $name = false ) {
1311 $this->mName
= $name;
1312 $this->mActorId
= null;
1313 $this->mRealName
= '';
1315 $this->mOptionOverrides
= null;
1316 $this->mOptionsLoaded
= false;
1318 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1319 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1320 if ( $loggedOut !== 0 ) {
1321 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1323 $this->mTouched
= '1'; # Allow any pages to be cached
1326 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1327 $this->mEmailAuthenticated
= null;
1328 $this->mEmailToken
= '';
1329 $this->mEmailTokenExpires
= null;
1330 $this->mRegistration
= wfTimestamp( TS_MW
);
1331 $this->mGroupMemberships
= [];
1333 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1337 * Return whether an item has been loaded.
1339 * @param string $item Item to check. Current possibilities:
1343 * @param string $all 'all' to check if the whole object has been loaded
1344 * or any other string to check if only the item is available (e.g.
1348 public function isItemLoaded( $item, $all = 'all' ) {
1349 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1350 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1354 * Set that an item has been loaded
1356 * @param string $item
1358 protected function setItemLoaded( $item ) {
1359 if ( is_array( $this->mLoadedItems
) ) {
1360 $this->mLoadedItems
[$item] = true;
1365 * Load user data from the session.
1367 * @return bool True if the user is logged in, false otherwise.
1369 private function loadFromSession() {
1372 Hooks
::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1373 if ( $result !== null ) {
1377 // MediaWiki\Session\Session already did the necessary authentication of the user
1378 // returned here, so just use it if applicable.
1379 $session = $this->getRequest()->getSession();
1380 $user = $session->getUser();
1381 if ( $user->isLoggedIn() ) {
1382 $this->loadFromUserObject( $user );
1383 if ( $user->isBlocked() ) {
1384 // If this user is autoblocked, set a cookie to track the Block. This has to be done on
1385 // every session load, because an autoblocked editor might not edit again from the same
1386 // IP address after being blocked.
1387 $this->trackBlockWithCookie();
1390 // Other code expects these to be set in the session, so set them.
1391 $session->set( 'wsUserID', $this->getId() );
1392 $session->set( 'wsUserName', $this->getName() );
1393 $session->set( 'wsToken', $this->getToken() );
1402 * Set the 'BlockID' cookie depending on block type and user authentication status.
1404 public function trackBlockWithCookie() {
1405 $block = $this->getBlock();
1407 if ( $block && $this->getRequest()->getCookie( 'BlockID' ) === null ) {
1408 if ( $block->shouldTrackWithCookie( $this->isAnon() ) ) {
1409 $block->setCookie( $this->getRequest()->response() );
1415 * Load user and user_group data from the database.
1416 * $this->mId must be set, this is how the user is identified.
1418 * @param int $flags User::READ_* constant bitfield
1419 * @return bool True if the user exists, false if the user is anonymous
1421 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1423 $this->mId
= intval( $this->mId
);
1425 if ( !$this->mId
) {
1426 // Anonymous users are not in the database
1427 $this->loadDefaults();
1431 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1432 $db = wfGetDB( $index );
1434 $userQuery = self
::getQueryInfo();
1435 $s = $db->selectRow(
1436 $userQuery['tables'],
1437 $userQuery['fields'],
1438 [ 'user_id' => $this->mId
],
1444 $this->queryFlagsUsed
= $flags;
1445 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1447 if ( $s !== false ) {
1448 // Initialise user table data
1449 $this->loadFromRow( $s );
1450 $this->mGroupMemberships
= null; // deferred
1451 $this->getEditCount(); // revalidation for nulls
1457 $this->loadDefaults();
1463 * Initialize this object from a row from the user table.
1465 * @param stdClass $row Row from the user table to load.
1466 * @param array|null $data Further user data to load into the object
1468 * user_groups Array of arrays or stdClass result rows out of the user_groups
1469 * table. Previously you were supposed to pass an array of strings
1470 * here, but we also need expiry info nowadays, so an array of
1471 * strings is ignored.
1472 * user_properties Array with properties out of the user_properties table
1474 protected function loadFromRow( $row, $data = null ) {
1475 global $wgActorTableSchemaMigrationStage;
1477 if ( !is_object( $row ) ) {
1478 throw new InvalidArgumentException( '$row must be an object' );
1483 $this->mGroupMemberships
= null; // deferred
1485 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
1486 // but it does little harm and might be needed for write callers loading a User.
1487 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
1488 if ( isset( $row->actor_id
) ) {
1489 $this->mActorId
= (int)$row->actor_id
;
1490 if ( $this->mActorId
!== 0 ) {
1491 $this->mFrom
= 'actor';
1493 $this->setItemLoaded( 'actor' );
1499 if ( isset( $row->user_name
) && $row->user_name
!== '' ) {
1500 $this->mName
= $row->user_name
;
1501 $this->mFrom
= 'name';
1502 $this->setItemLoaded( 'name' );
1507 if ( isset( $row->user_real_name
) ) {
1508 $this->mRealName
= $row->user_real_name
;
1509 $this->setItemLoaded( 'realname' );
1514 if ( isset( $row->user_id
) ) {
1515 $this->mId
= intval( $row->user_id
);
1516 if ( $this->mId
!== 0 ) {
1517 $this->mFrom
= 'id';
1519 $this->setItemLoaded( 'id' );
1524 if ( isset( $row->user_id
) && isset( $row->user_name
) && $row->user_name
!== '' ) {
1525 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1528 if ( isset( $row->user_editcount
) ) {
1529 $this->mEditCount
= $row->user_editcount
;
1534 if ( isset( $row->user_touched
) ) {
1535 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1540 if ( isset( $row->user_token
) ) {
1541 // The definition for the column is binary(32), so trim the NULs
1542 // that appends. The previous definition was char(32), so trim
1544 $this->mToken
= rtrim( $row->user_token
, " \0" );
1545 if ( $this->mToken
=== '' ) {
1546 $this->mToken
= null;
1552 if ( isset( $row->user_email
) ) {
1553 $this->mEmail
= $row->user_email
;
1554 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1555 $this->mEmailToken
= $row->user_email_token
;
1556 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1557 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1563 $this->mLoadedItems
= true;
1566 if ( is_array( $data ) ) {
1567 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1568 if ( $data['user_groups'] === [] ) {
1569 $this->mGroupMemberships
= [];
1571 $firstGroup = reset( $data['user_groups'] );
1572 if ( is_array( $firstGroup ) ||
is_object( $firstGroup ) ) {
1573 $this->mGroupMemberships
= [];
1574 foreach ( $data['user_groups'] as $row ) {
1575 $ugm = UserGroupMembership
::newFromRow( (object)$row );
1576 $this->mGroupMemberships
[$ugm->getGroup()] = $ugm;
1581 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1582 $this->loadOptions( $data['user_properties'] );
1588 * Load the data for this user object from another user object.
1592 protected function loadFromUserObject( $user ) {
1594 foreach ( self
::$mCacheVars as $var ) {
1595 $this->$var = $user->$var;
1600 * Load the groups from the database if they aren't already loaded.
1602 private function loadGroups() {
1603 if ( is_null( $this->mGroupMemberships
) ) {
1604 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1605 ?
wfGetDB( DB_MASTER
)
1606 : wfGetDB( DB_REPLICA
);
1607 $this->mGroupMemberships
= UserGroupMembership
::getMembershipsForUser(
1613 * Add the user to the group if he/she meets given criteria.
1615 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1616 * possible to remove manually via Special:UserRights. In such case it
1617 * will not be re-added automatically. The user will also not lose the
1618 * group if they no longer meet the criteria.
1620 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1622 * @return array Array of groups the user has been promoted to.
1624 * @see $wgAutopromoteOnce
1626 public function addAutopromoteOnceGroups( $event ) {
1627 global $wgAutopromoteOnceLogInRC;
1629 if ( wfReadOnly() ||
!$this->getId() ) {
1633 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1634 if ( $toPromote === [] ) {
1638 if ( !$this->checkAndSetTouched() ) {
1639 return []; // raced out (bug T48834)
1642 $oldGroups = $this->getGroups(); // previous groups
1643 $oldUGMs = $this->getGroupMemberships();
1644 foreach ( $toPromote as $group ) {
1645 $this->addGroup( $group );
1647 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1648 $newUGMs = $this->getGroupMemberships();
1650 // update groups in external authentication database
1651 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );
1653 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1654 $logEntry->setPerformer( $this );
1655 $logEntry->setTarget( $this->getUserPage() );
1656 $logEntry->setParameters( [
1657 '4::oldgroups' => $oldGroups,
1658 '5::newgroups' => $newGroups,
1660 $logid = $logEntry->insert();
1661 if ( $wgAutopromoteOnceLogInRC ) {
1662 $logEntry->publish( $logid );
1669 * Builds update conditions. Additional conditions may be added to $conditions to
1670 * protected against race conditions using a compare-and-set (CAS) mechanism
1671 * based on comparing $this->mTouched with the user_touched field.
1673 * @param Database $db
1674 * @param array $conditions WHERE conditions for use with Database::update
1675 * @return array WHERE conditions for use with Database::update
1677 protected function makeUpdateConditions( Database
$db, array $conditions ) {
1678 if ( $this->mTouched
) {
1679 // CAS check: only update if the row wasn't changed sicne it was loaded.
1680 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1687 * Bump user_touched if it didn't change since this object was loaded
1689 * On success, the mTouched field is updated.
1690 * The user serialization cache is always cleared.
1692 * @return bool Whether user_touched was actually updated
1695 protected function checkAndSetTouched() {
1698 if ( !$this->mId
) {
1699 return false; // anon
1702 // Get a new user_touched that is higher than the old one
1703 $newTouched = $this->newTouchedTimestamp();
1705 $dbw = wfGetDB( DB_MASTER
);
1706 $dbw->update( 'user',
1707 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1708 $this->makeUpdateConditions( $dbw, [
1709 'user_id' => $this->mId
,
1713 $success = ( $dbw->affectedRows() > 0 );
1716 $this->mTouched
= $newTouched;
1717 $this->clearSharedCache();
1719 // Clears on failure too since that is desired if the cache is stale
1720 $this->clearSharedCache( 'refresh' );
1727 * Clear various cached data stored in this object. The cache of the user table
1728 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1730 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1731 * given source. May be "name", "id", "actor", "defaults", "session", or false for no reload.
1733 public function clearInstanceCache( $reloadFrom = false ) {
1734 $this->mNewtalk
= -1;
1735 $this->mDatePreference
= null;
1736 $this->mBlockedby
= -1; # Unset
1737 $this->mHash
= false;
1738 $this->mRights
= null;
1739 $this->mEffectiveGroups
= null;
1740 $this->mImplicitGroups
= null;
1741 $this->mGroupMemberships
= null;
1742 $this->mOptions
= null;
1743 $this->mOptionsLoaded
= false;
1744 $this->mEditCount
= null;
1746 if ( $reloadFrom ) {
1747 $this->mLoadedItems
= [];
1748 $this->mFrom
= $reloadFrom;
1753 * Combine the language default options with any site-specific options
1754 * and add the default language variants.
1756 * @return array Array of String options
1758 public static function getDefaultOptions() {
1759 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgDefaultSkin;
1761 static $defOpt = null;
1762 static $defOptLang = null;
1764 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
1765 if ( $defOpt !== null && $defOptLang === $contLang->getCode() ) {
1766 // The content language does not change (and should not change) mid-request, but the
1767 // unit tests change it anyway, and expect this method to return values relevant to the
1768 // current content language.
1772 $defOpt = $wgDefaultUserOptions;
1773 // Default language setting
1774 $defOptLang = $contLang->getCode();
1775 $defOpt['language'] = $defOptLang;
1776 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1777 if ( $langCode === $contLang->getCode() ) {
1778 $defOpt['variant'] = $langCode;
1780 $defOpt["variant-$langCode"] = $langCode;
1784 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1785 // since extensions may change the set of searchable namespaces depending
1786 // on user groups/permissions.
1787 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1788 $defOpt['searchNs' . $nsnum] = (bool)$val;
1790 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1792 Hooks
::run( 'UserGetDefaultOptions', [ &$defOpt ] );
1798 * Get a given default option value.
1800 * @param string $opt Name of option to retrieve
1801 * @return string Default option value
1803 public static function getDefaultOption( $opt ) {
1804 $defOpts = self
::getDefaultOptions();
1805 return $defOpts[$opt] ??
null;
1809 * Get blocking information
1810 * @param bool $fromReplica Whether to check the replica DB first.
1811 * To improve performance, non-critical checks are done against replica DBs.
1812 * Check when actually saving should be done against master.
1814 private function getBlockedStatus( $fromReplica = true ) {
1815 global $wgProxyWhitelist, $wgApplyIpBlocksToXff, $wgSoftBlockRanges;
1817 if ( $this->mBlockedby
!= -1 ) {
1821 wfDebug( __METHOD__
. ": checking...\n" );
1823 // Initialize data...
1824 // Otherwise something ends up stomping on $this->mBlockedby when
1825 // things get lazy-loaded later, causing false positive block hits
1826 // due to -1 !== 0. Probably session-related... Nothing should be
1827 // overwriting mBlockedby, surely?
1830 # We only need to worry about passing the IP address to the Block generator if the
1831 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1832 # know which IP address they're actually coming from
1834 $sessionUser = RequestContext
::getMain()->getUser();
1835 // the session user is set up towards the end of Setup.php. Until then,
1836 // assume it's a logged-out user.
1837 $globalUserName = $sessionUser->isSafeToLoad()
1838 ?
$sessionUser->getName()
1839 : IP
::sanitizeIP( $sessionUser->getRequest()->getIP() );
1840 if ( $this->getName() === $globalUserName && !$this->isAllowed( 'ipblock-exempt' ) ) {
1841 $ip = $this->getRequest()->getIP();
1845 $block = Block
::newFromTarget( $this, $ip, !$fromReplica );
1848 if ( !$block instanceof Block
) {
1849 $block = $this->getBlockFromCookieValue( $this->getRequest()->getCookie( 'BlockID' ) );
1853 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1855 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1856 $block = new Block( [
1857 'byText' => wfMessage( 'proxyblocker' )->text(),
1858 'reason' => wfMessage( 'proxyblockreason' )->plain(),
1860 'systemBlock' => 'proxy',
1862 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1863 $block = new Block( [
1864 'byText' => wfMessage( 'sorbs' )->text(),
1865 'reason' => wfMessage( 'sorbsreason' )->plain(),
1867 'systemBlock' => 'dnsbl',
1872 // (T25343) Apply IP blocks to the contents of XFF headers, if enabled
1873 if ( !$block instanceof Block
1874 && $wgApplyIpBlocksToXff
1876 && !in_array( $ip, $wgProxyWhitelist )
1878 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1879 $xff = array_map( 'trim', explode( ',', $xff ) );
1880 $xff = array_diff( $xff, [ $ip ] );
1881 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$fromReplica );
1882 $block = Block
::chooseBlock( $xffblocks, $xff );
1883 if ( $block instanceof Block
) {
1884 # Mangle the reason to alert the user that the block
1885 # originated from matching the X-Forwarded-For header.
1886 $block->setReason( wfMessage( 'xffblockreason', $block->getReason() )->plain() );
1890 if ( !$block instanceof Block
1893 && IP
::isInRanges( $ip, $wgSoftBlockRanges )
1895 $block = new Block( [
1897 'byText' => 'MediaWiki default',
1898 'reason' => wfMessage( 'softblockrangesreason', $ip )->plain(),
1900 'systemBlock' => 'wgSoftBlockRanges',
1904 if ( $block instanceof Block
) {
1905 wfDebug( __METHOD__
. ": Found block.\n" );
1906 $this->mBlock
= $block;
1907 $this->mBlockedby
= $block->getByName();
1908 $this->mBlockreason
= $block->getReason();
1909 $this->mHideName
= $block->getHideName();
1910 $this->mAllowUsertalk
= $block->isUsertalkEditAllowed();
1912 $this->mBlock
= null;
1913 $this->mBlockedby
= '';
1914 $this->mBlockreason
= '';
1915 $this->mHideName
= 0;
1916 $this->mAllowUsertalk
= false;
1919 // Avoid PHP 7.1 warning of passing $this by reference
1922 Hooks
::run( 'GetBlockedStatus', [ &$thisUser ] );
1926 * Try to load a Block from an ID given in a cookie value.
1927 * @param string|null $blockCookieVal The cookie value to check.
1928 * @return Block|bool The Block object, or false if none could be loaded.
1930 protected function getBlockFromCookieValue( $blockCookieVal ) {
1931 // Make sure there's something to check. The cookie value must start with a number.
1932 if ( strlen( $blockCookieVal ) < 1 ||
!is_numeric( substr( $blockCookieVal, 0, 1 ) ) ) {
1935 // Load the Block from the ID in the cookie.
1936 $blockCookieId = Block
::getIdFromCookieValue( $blockCookieVal );
1937 if ( $blockCookieId !== null ) {
1938 // An ID was found in the cookie.
1939 $tmpBlock = Block
::newFromID( $blockCookieId );
1940 if ( $tmpBlock instanceof Block
) {
1941 $config = RequestContext
::getMain()->getConfig();
1943 switch ( $tmpBlock->getType() ) {
1944 case Block
::TYPE_USER
:
1945 $blockIsValid = !$tmpBlock->isExpired() && $tmpBlock->isAutoblocking();
1946 $useBlockCookie = ( $config->get( 'CookieSetOnAutoblock' ) === true );
1948 case Block
::TYPE_IP
:
1949 case Block
::TYPE_RANGE
:
1950 // If block is type IP or IP range, load only if user is not logged in (T152462)
1951 $blockIsValid = !$tmpBlock->isExpired() && !$this->isLoggedIn();
1952 $useBlockCookie = ( $config->get( 'CookieSetOnIpBlock' ) === true );
1955 $blockIsValid = false;
1956 $useBlockCookie = false;
1959 if ( $blockIsValid && $useBlockCookie ) {
1964 // If the block is not valid, remove the cookie.
1965 Block
::clearCookie( $this->getRequest()->response() );
1967 // If the block doesn't exist, remove the cookie.
1968 Block
::clearCookie( $this->getRequest()->response() );
1975 * Whether the given IP is in a DNS blacklist.
1977 * @param string $ip IP to check
1978 * @param bool $checkWhitelist Whether to check the whitelist first
1979 * @return bool True if blacklisted.
1981 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1982 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1984 if ( !$wgEnableDnsBlacklist ||
1985 ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1990 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
1994 * Whether the given IP is in a given DNS blacklist.
1996 * @param string $ip IP to check
1997 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1998 * @return bool True if blacklisted.
2000 public function inDnsBlacklist( $ip, $bases ) {
2002 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
2003 if ( IP
::isIPv4( $ip ) ) {
2004 // Reverse IP, T23255
2005 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
2007 foreach ( (array)$bases as $base ) {
2009 // If we have an access key, use that too (ProjectHoneypot, etc.)
2011 if ( is_array( $base ) ) {
2012 if ( count( $base ) >= 2 ) {
2013 // Access key is 1, base URL is 0
2014 $host = "{$base[1]}.$ipReversed.{$base[0]}";
2016 $host = "$ipReversed.{$base[0]}";
2018 $basename = $base[0];
2020 $host = "$ipReversed.$base";
2024 $ipList = gethostbynamel( $host );
2027 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
2032 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
2040 * Check if an IP address is in the local proxy list
2046 public static function isLocallyBlockedProxy( $ip ) {
2047 global $wgProxyList;
2049 if ( !$wgProxyList ) {
2053 if ( !is_array( $wgProxyList ) ) {
2054 // Load values from the specified file
2055 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
2058 $resultProxyList = [];
2059 $deprecatedIPEntries = [];
2061 // backward compatibility: move all ip addresses in keys to values
2062 foreach ( $wgProxyList as $key => $value ) {
2063 $keyIsIP = IP
::isIPAddress( $key );
2064 $valueIsIP = IP
::isIPAddress( $value );
2065 if ( $keyIsIP && !$valueIsIP ) {
2066 $deprecatedIPEntries[] = $key;
2067 $resultProxyList[] = $key;
2068 } elseif ( $keyIsIP && $valueIsIP ) {
2069 $deprecatedIPEntries[] = $key;
2070 $resultProxyList[] = $key;
2071 $resultProxyList[] = $value;
2073 $resultProxyList[] = $value;
2077 if ( $deprecatedIPEntries ) {
2079 'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
2080 implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
2083 $proxyListIPSet = new IPSet( $resultProxyList );
2084 return $proxyListIPSet->match( $ip );
2088 * Is this user subject to rate limiting?
2090 * @return bool True if rate limited
2092 public function isPingLimitable() {
2093 global $wgRateLimitsExcludedIPs;
2094 if ( IP
::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
2095 // No other good way currently to disable rate limits
2096 // for specific IPs. :P
2097 // But this is a crappy hack and should die.
2100 return !$this->isAllowed( 'noratelimit' );
2104 * Primitive rate limits: enforce maximum actions per time period
2105 * to put a brake on flooding.
2107 * The method generates both a generic profiling point and a per action one
2108 * (suffix being "-$action".
2110 * @note When using a shared cache like memcached, IP-address
2111 * last-hit counters will be shared across wikis.
2113 * @param string $action Action to enforce; 'edit' if unspecified
2114 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
2115 * @return bool True if a rate limiter was tripped
2117 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
2118 // Avoid PHP 7.1 warning of passing $this by reference
2120 // Call the 'PingLimiter' hook
2122 if ( !Hooks
::run( 'PingLimiter', [ &$user, $action, &$result, $incrBy ] ) ) {
2126 global $wgRateLimits;
2127 if ( !isset( $wgRateLimits[$action] ) ) {
2131 $limits = array_merge(
2132 [ '&can-bypass' => true ],
2133 $wgRateLimits[$action]
2136 // Some groups shouldn't trigger the ping limiter, ever
2137 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
2142 $id = $this->getId();
2144 $isNewbie = $this->isNewbie();
2145 $cache = ObjectCache
::getLocalClusterInstance();
2149 if ( isset( $limits['anon'] ) ) {
2150 $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
2152 } elseif ( isset( $limits['user'] ) ) {
2153 // limits for logged-in users
2154 $userLimit = $limits['user'];
2157 // limits for anons and for newbie logged-in users
2160 if ( isset( $limits['ip'] ) ) {
2161 $ip = $this->getRequest()->getIP();
2162 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
2164 // subnet-based limits
2165 if ( isset( $limits['subnet'] ) ) {
2166 $ip = $this->getRequest()->getIP();
2167 $subnet = IP
::getSubnet( $ip );
2168 if ( $subnet !== false ) {
2169 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
2174 // Check for group-specific permissions
2175 // If more than one group applies, use the group with the highest limit ratio (max/period)
2176 foreach ( $this->getGroups() as $group ) {
2177 if ( isset( $limits[$group] ) ) {
2178 if ( $userLimit === false
2179 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
2181 $userLimit = $limits[$group];
2186 // limits for newbie logged-in users (override all the normal user limits)
2187 if ( $id !== 0 && $isNewbie && isset( $limits['newbie'] ) ) {
2188 $userLimit = $limits['newbie'];
2191 // Set the user limit key
2192 if ( $userLimit !== false ) {
2193 list( $max, $period ) = $userLimit;
2194 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
2195 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
2198 // ip-based limits for all ping-limitable users
2199 if ( isset( $limits['ip-all'] ) ) {
2200 $ip = $this->getRequest()->getIP();
2201 // ignore if user limit is more permissive
2202 if ( $isNewbie ||
$userLimit === false
2203 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
2204 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
2208 // subnet-based limits for all ping-limitable users
2209 if ( isset( $limits['subnet-all'] ) ) {
2210 $ip = $this->getRequest()->getIP();
2211 $subnet = IP
::getSubnet( $ip );
2212 if ( $subnet !== false ) {
2213 // ignore if user limit is more permissive
2214 if ( $isNewbie ||
$userLimit === false
2215 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
2216 > $userLimit[0] / $userLimit[1] ) {
2217 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
2223 foreach ( $keys as $key => $limit ) {
2224 list( $max, $period ) = $limit;
2225 $summary = "(limit $max in {$period}s)";
2226 $count = $cache->get( $key );
2229 if ( $count >= $max ) {
2230 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
2231 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
2234 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
2237 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
2238 if ( $incrBy > 0 ) {
2239 $cache->add( $key, 0, intval( $period ) ); // first ping
2242 if ( $incrBy > 0 ) {
2243 $cache->incr( $key, $incrBy );
2251 * Check if user is blocked
2253 * @param bool $fromReplica Whether to check the replica DB instead of
2254 * the master. Hacked from false due to horrible probs on site.
2255 * @return bool True if blocked, false otherwise
2257 public function isBlocked( $fromReplica = true ) {
2258 return $this->getBlock( $fromReplica ) instanceof Block
&&
2259 $this->getBlock()->appliesToRight( 'edit' );
2263 * Get the block affecting the user, or null if the user is not blocked
2265 * @param bool $fromReplica Whether to check the replica DB instead of the master
2266 * @return Block|null
2268 public function getBlock( $fromReplica = true ) {
2269 $this->getBlockedStatus( $fromReplica );
2270 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
2274 * Check if user is blocked from editing a particular article
2276 * @param Title $title Title to check
2277 * @param bool $fromReplica Whether to check the replica DB instead of the master
2280 public function isBlockedFrom( $title, $fromReplica = false ) {
2281 $blocked = $this->isHidden();
2284 $block = $this->getBlock( $fromReplica );
2286 // Special handling for a user's own talk page. The block is not aware
2287 // of the user, so this must be done here.
2288 if ( $title->equals( $this->getTalkPage() ) ) {
2289 $blocked = $block->appliesToUsertalk( $title );
2291 $blocked = $block->appliesToTitle( $title );
2296 // only for the purpose of the hook. We really don't need this here.
2297 $allowUsertalk = $this->mAllowUsertalk
;
2299 Hooks
::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
2305 * If user is blocked, return the name of the user who placed the block
2306 * @return string Name of blocker
2308 public function blockedBy() {
2309 $this->getBlockedStatus();
2310 return $this->mBlockedby
;
2314 * If user is blocked, return the specified reason for the block
2315 * @return string Blocking reason
2317 public function blockedFor() {
2318 $this->getBlockedStatus();
2319 return $this->mBlockreason
;
2323 * If user is blocked, return the ID for the block
2324 * @return int Block ID
2326 public function getBlockId() {
2327 $this->getBlockedStatus();
2328 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2332 * Check if user is blocked on all wikis.
2333 * Do not use for actual edit permission checks!
2334 * This is intended for quick UI checks.
2336 * @param string $ip IP address, uses current client if none given
2337 * @return bool True if blocked, false otherwise
2339 public function isBlockedGlobally( $ip = '' ) {
2340 return $this->getGlobalBlock( $ip ) instanceof Block
;
2344 * Check if user is blocked on all wikis.
2345 * Do not use for actual edit permission checks!
2346 * This is intended for quick UI checks.
2348 * @param string $ip IP address, uses current client if none given
2349 * @return Block|null Block object if blocked, null otherwise
2350 * @throws FatalError
2351 * @throws MWException
2353 public function getGlobalBlock( $ip = '' ) {
2354 if ( $this->mGlobalBlock
!== null ) {
2355 return $this->mGlobalBlock ?
: null;
2357 // User is already an IP?
2358 if ( IP
::isIPAddress( $this->getName() ) ) {
2359 $ip = $this->getName();
2361 $ip = $this->getRequest()->getIP();
2363 // Avoid PHP 7.1 warning of passing $this by reference
2367 Hooks
::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
2369 if ( $blocked && $block === null ) {
2370 // back-compat: UserIsBlockedGlobally didn't have $block param first
2371 $block = new Block( [
2373 'systemBlock' => 'global-block'
2377 $this->mGlobalBlock
= $blocked ?
$block : false;
2378 return $this->mGlobalBlock ?
: null;
2382 * Check if user account is locked
2384 * @return bool True if locked, false otherwise
2386 public function isLocked() {
2387 if ( $this->mLocked
!== null ) {
2388 return $this->mLocked
;
2391 $this->mLocked
= false;
2392 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2393 return $this->mLocked
;
2397 * Check if user account is hidden
2399 * @return bool True if hidden, false otherwise
2401 public function isHidden() {
2402 if ( $this->mHideName
!== null ) {
2403 return (bool)$this->mHideName
;
2405 $this->getBlockedStatus();
2406 if ( !$this->mHideName
) {
2408 $this->mHideName
= false;
2409 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2411 return (bool)$this->mHideName
;
2415 * Get the user's ID.
2416 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2418 public function getId() {
2419 if ( $this->mId
=== null && $this->mName
!== null && self
::isIP( $this->mName
) ) {
2420 // Special case, we know the user is anonymous
2424 if ( !$this->isItemLoaded( 'id' ) ) {
2425 // Don't load if this was initialized from an ID
2429 return (int)$this->mId
;
2433 * Set the user and reload all fields according to a given ID
2434 * @param int $v User ID to reload
2436 public function setId( $v ) {
2438 $this->clearInstanceCache( 'id' );
2442 * Get the user name, or the IP of an anonymous user
2443 * @return string User's name or IP address
2445 public function getName() {
2446 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2447 // Special case optimisation
2448 return $this->mName
;
2452 if ( $this->mName
=== false ) {
2454 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2457 return $this->mName
;
2461 * Set the user name.
2463 * This does not reload fields from the database according to the given
2464 * name. Rather, it is used to create a temporary "nonexistent user" for
2465 * later addition to the database. It can also be used to set the IP
2466 * address for an anonymous user to something other than the current
2469 * @note User::newFromName() has roughly the same function, when the named user
2471 * @param string $str New user name to set
2473 public function setName( $str ) {
2475 $this->mName
= $str;
2479 * Get the user's actor ID.
2481 * @param IDatabase|null $dbw Assign a new actor ID, using this DB handle, if none exists
2482 * @return int The actor's ID, or 0 if no actor ID exists and $dbw was null
2484 public function getActorId( IDatabase
$dbw = null ) {
2485 global $wgActorTableSchemaMigrationStage;
2487 // Technically we should always return 0 without SCHEMA_COMPAT_READ_NEW,
2488 // but it does little harm and might be needed for write callers loading a User.
2489 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) ) {
2493 if ( !$this->isItemLoaded( 'actor' ) ) {
2497 // Currently $this->mActorId might be null if $this was loaded from a
2498 // cache entry that was written when $wgActorTableSchemaMigrationStage
2499 // was SCHEMA_COMPAT_OLD. Once that is no longer a possibility (i.e. when
2500 // User::VERSION is incremented after $wgActorTableSchemaMigrationStage
2501 // has been removed), that condition may be removed.
2502 if ( $this->mActorId
=== null ||
!$this->mActorId
&& $dbw ) {
2504 'actor_user' => $this->getId() ?
: null,
2505 'actor_name' => (string)$this->getName(),
2508 if ( $q['actor_user'] === null && self
::isUsableName( $q['actor_name'] ) ) {
2509 throw new CannotCreateActorException(
2510 'Cannot create an actor for a usable name that is not an existing user'
2513 if ( $q['actor_name'] === '' ) {
2514 throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
2516 $dbw->insert( 'actor', $q, __METHOD__
, [ 'IGNORE' ] );
2517 if ( $dbw->affectedRows() ) {
2518 $this->mActorId
= (int)$dbw->insertId();
2521 // Use LOCK IN SHARE MODE to bypass any MySQL REPEATABLE-READ snapshot.
2522 $this->mActorId
= (int)$dbw->selectField(
2527 [ 'LOCK IN SHARE MODE' ]
2529 if ( !$this->mActorId
) {
2530 throw new CannotCreateActorException(
2531 "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
2535 $this->invalidateCache();
2537 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2538 $db = wfGetDB( $index );
2539 $this->mActorId
= (int)$db->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2541 $this->setItemLoaded( 'actor' );
2544 return (int)$this->mActorId
;
2548 * Get the user's name escaped by underscores.
2549 * @return string Username escaped by underscores.
2551 public function getTitleKey() {
2552 return str_replace( ' ', '_', $this->getName() );
2556 * Check if the user has new messages.
2557 * @return bool True if the user has new messages
2559 public function getNewtalk() {
2562 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2563 if ( $this->mNewtalk
=== -1 ) {
2564 $this->mNewtalk
= false; # reset talk page status
2566 // Check memcached separately for anons, who have no
2567 // entire User object stored in there.
2568 if ( !$this->mId
) {
2569 global $wgDisableAnonTalk;
2570 if ( $wgDisableAnonTalk ) {
2571 // Anon newtalk disabled by configuration.
2572 $this->mNewtalk
= false;
2574 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2577 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2581 return (bool)$this->mNewtalk
;
2585 * Return the data needed to construct links for new talk page message
2586 * alerts. If there are new messages, this will return an associative array
2587 * with the following data:
2588 * wiki: The database name of the wiki
2589 * link: Root-relative link to the user's talk page
2590 * rev: The last talk page revision that the user has seen or null. This
2591 * is useful for building diff links.
2592 * If there are no new messages, it returns an empty array.
2593 * @note This function was designed to accomodate multiple talk pages, but
2594 * currently only returns a single link and revision.
2597 public function getNewMessageLinks() {
2598 // Avoid PHP 7.1 warning of passing $this by reference
2601 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
2605 if ( !$this->getNewtalk() ) {
2608 $utp = $this->getTalkPage();
2609 $dbr = wfGetDB( DB_REPLICA
);
2610 // Get the "last viewed rev" timestamp from the oldest message notification
2611 $timestamp = $dbr->selectField( 'user_newtalk',
2612 'MIN(user_last_timestamp)',
2613 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2615 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2618 'wiki' => WikiMap
::getWikiIdFromDbDomain( WikiMap
::getCurrentWikiDbDomain() ),
2619 'link' => $utp->getLocalURL(),
2626 * Get the revision ID for the last talk page revision viewed by the talk
2628 * @return int|null Revision ID or null
2630 public function getNewMessageRevisionId() {
2631 $newMessageRevisionId = null;
2632 $newMessageLinks = $this->getNewMessageLinks();
2634 // Note: getNewMessageLinks() never returns more than a single link
2635 // and it is always for the same wiki, but we double-check here in
2636 // case that changes some time in the future.
2637 if ( $newMessageLinks && count( $newMessageLinks ) === 1
2638 && WikiMap
::isCurrentWikiId( $newMessageLinks[0]['wiki'] )
2639 && $newMessageLinks[0]['rev']
2641 /** @var Revision $newMessageRevision */
2642 $newMessageRevision = $newMessageLinks[0]['rev'];
2643 $newMessageRevisionId = $newMessageRevision->getId();
2646 return $newMessageRevisionId;
2650 * Internal uncached check for new messages
2653 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2654 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2655 * @return bool True if the user has new messages
2657 protected function checkNewtalk( $field, $id ) {
2658 $dbr = wfGetDB( DB_REPLICA
);
2660 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2662 return $ok !== false;
2666 * Add or update the new messages flag
2667 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2668 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2669 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2670 * @return bool True if successful, false otherwise
2672 protected function updateNewtalk( $field, $id, $curRev = null ) {
2673 // Get timestamp of the talk page revision prior to the current one
2674 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2675 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2676 // Mark the user as having new messages since this revision
2677 $dbw = wfGetDB( DB_MASTER
);
2678 $dbw->insert( 'user_newtalk',
2679 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2682 if ( $dbw->affectedRows() ) {
2683 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2687 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2692 * Clear the new messages flag for the given user
2693 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2694 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2695 * @return bool True if successful, false otherwise
2697 protected function deleteNewtalk( $field, $id ) {
2698 $dbw = wfGetDB( DB_MASTER
);
2699 $dbw->delete( 'user_newtalk',
2702 if ( $dbw->affectedRows() ) {
2703 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2707 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2712 * Update the 'You have new messages!' status.
2713 * @param bool $val Whether the user has new messages
2714 * @param Revision|null $curRev New, as yet unseen revision of the user talk
2715 * page. Ignored if null or !$val.
2717 public function setNewtalk( $val, $curRev = null ) {
2718 if ( wfReadOnly() ) {
2723 $this->mNewtalk
= $val;
2725 if ( $this->isAnon() ) {
2727 $id = $this->getName();
2730 $id = $this->getId();
2734 $changed = $this->updateNewtalk( $field, $id, $curRev );
2736 $changed = $this->deleteNewtalk( $field, $id );
2740 $this->invalidateCache();
2745 * Generate a current or new-future timestamp to be stored in the
2746 * user_touched field when we update things.
2748 * @return string Timestamp in TS_MW format
2750 private function newTouchedTimestamp() {
2752 if ( $this->mTouched
) {
2753 $time = max( $time, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2756 return wfTimestamp( TS_MW
, $time );
2760 * Clear user data from memcached
2762 * Use after applying updates to the database; caller's
2763 * responsibility to update user_touched if appropriate.
2765 * Called implicitly from invalidateCache() and saveSettings().
2767 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2769 public function clearSharedCache( $mode = 'changed' ) {
2770 if ( !$this->getId() ) {
2774 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2775 $key = $this->getCacheKey( $cache );
2776 if ( $mode === 'refresh' ) {
2777 $cache->delete( $key, 1 );
2779 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2780 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2781 $lb->getConnection( DB_MASTER
)->onTransactionPreCommitOrIdle(
2782 function () use ( $cache, $key ) {
2783 $cache->delete( $key );
2788 $cache->delete( $key );
2794 * Immediately touch the user data cache for this account
2796 * Calls touch() and removes account data from memcached
2798 public function invalidateCache() {
2800 $this->clearSharedCache();
2804 * Update the "touched" timestamp for the user
2806 * This is useful on various login/logout events when making sure that
2807 * a browser or proxy that has multiple tenants does not suffer cache
2808 * pollution where the new user sees the old users content. The value
2809 * of getTouched() is checked when determining 304 vs 200 responses.
2810 * Unlike invalidateCache(), this preserves the User object cache and
2811 * avoids database writes.
2815 public function touch() {
2816 $id = $this->getId();
2818 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2819 $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
2820 $cache->touchCheckKey( $key );
2821 $this->mQuickTouched
= null;
2826 * Validate the cache for this account.
2827 * @param string $timestamp A timestamp in TS_MW format
2830 public function validateCache( $timestamp ) {
2831 return ( $timestamp >= $this->getTouched() );
2835 * Get the user touched timestamp
2837 * Use this value only to validate caches via inequalities
2838 * such as in the case of HTTP If-Modified-Since response logic
2840 * @return string TS_MW Timestamp
2842 public function getTouched() {
2846 if ( $this->mQuickTouched
=== null ) {
2847 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2848 $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId
);
2850 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2853 return max( $this->mTouched
, $this->mQuickTouched
);
2856 return $this->mTouched
;
2860 * Get the user_touched timestamp field (time of last DB updates)
2861 * @return string TS_MW Timestamp
2864 public function getDBTouched() {
2867 return $this->mTouched
;
2871 * Set the password and reset the random token.
2872 * Calls through to authentication plugin if necessary;
2873 * will have no effect if the auth plugin refuses to
2874 * pass the change through or if the legal password
2877 * As a special case, setting the password to null
2878 * wipes it, so the account cannot be logged in until
2879 * a new password is set, for instance via e-mail.
2881 * @deprecated since 1.27, use AuthManager instead
2882 * @param string $str New password to set
2883 * @throws PasswordError On failure
2886 public function setPassword( $str ) {
2887 wfDeprecated( __METHOD__
, '1.27' );
2888 return $this->setPasswordInternal( $str );
2892 * Set the password and reset the random token unconditionally.
2894 * @deprecated since 1.27, use AuthManager instead
2895 * @param string|null $str New password to set or null to set an invalid
2896 * password hash meaning that the user will not be able to log in
2897 * through the web interface.
2899 public function setInternalPassword( $str ) {
2900 wfDeprecated( __METHOD__
, '1.27' );
2901 $this->setPasswordInternal( $str );
2905 * Actually set the password and such
2906 * @since 1.27 cannot set a password for a user not in the database
2907 * @param string|null $str New password to set or null to set an invalid
2908 * password hash meaning that the user will not be able to log in
2909 * through the web interface.
2910 * @return bool Success
2912 private function setPasswordInternal( $str ) {
2913 $manager = AuthManager
::singleton();
2915 // If the user doesn't exist yet, fail
2916 if ( !$manager->userExists( $this->getName() ) ) {
2917 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2920 $status = $this->changeAuthenticationData( [
2921 'username' => $this->getName(),
2925 if ( !$status->isGood() ) {
2926 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2927 ->info( __METHOD__
. ': Password change rejected: '
2928 . $status->getWikiText( null, null, 'en' ) );
2932 $this->setOption( 'watchlisttoken', false );
2933 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2939 * Changes credentials of the user.
2941 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2942 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2943 * e.g. when no provider handled the change.
2945 * @param array $data A set of authentication data in fieldname => value format. This is the
2946 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2950 public function changeAuthenticationData( array $data ) {
2951 $manager = AuthManager
::singleton();
2952 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2953 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2955 $status = Status
::newGood( 'ignored' );
2956 foreach ( $reqs as $req ) {
2957 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2959 if ( $status->getValue() === 'ignored' ) {
2960 $status->warning( 'authenticationdatachange-ignored' );
2963 if ( $status->isGood() ) {
2964 foreach ( $reqs as $req ) {
2965 $manager->changeAuthenticationData( $req );
2972 * Get the user's current token.
2973 * @param bool $forceCreation Force the generation of a new token if the
2974 * user doesn't have one (default=true for backwards compatibility).
2975 * @return string|null Token
2977 public function getToken( $forceCreation = true ) {
2978 global $wgAuthenticationTokenVersion;
2981 if ( !$this->mToken
&& $forceCreation ) {
2985 if ( !$this->mToken
) {
2986 // The user doesn't have a token, return null to indicate that.
2990 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
2991 // We return a random value here so existing token checks are very
2993 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2996 if ( $wgAuthenticationTokenVersion === null ) {
2997 // $wgAuthenticationTokenVersion not in use, so return the raw secret
2998 return $this->mToken
;
3001 // $wgAuthenticationTokenVersion in use, so hmac it.
3002 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
3004 // The raw hash can be overly long. Shorten it up.
3005 $len = max( 32, self
::TOKEN_LENGTH
);
3006 if ( strlen( $ret ) < $len ) {
3007 // Should never happen, even md5 is 128 bits
3008 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
3011 return substr( $ret, -$len );
3015 * Set the random token (used for persistent authentication)
3016 * Called from loadDefaults() among other places.
3018 * @param string|bool $token If specified, set the token to this value
3020 public function setToken( $token = false ) {
3022 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
3023 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3024 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
3025 } elseif ( !$token ) {
3026 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3028 $this->mToken
= $token;
3033 * Set the password for a password reminder or new account email
3035 * @deprecated Removed in 1.27. Use PasswordReset instead.
3036 * @param string $str New password to set or null to set an invalid
3037 * password hash meaning that the user will not be able to use it
3038 * @param bool $throttle If true, reset the throttle timestamp to the present
3040 public function setNewpassword( $str, $throttle = true ) {
3041 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
3045 * Get the user's e-mail address
3046 * @return string User's email address
3048 public function getEmail() {
3050 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
3051 return $this->mEmail
;
3055 * Get the timestamp of the user's e-mail authentication
3056 * @return string TS_MW timestamp
3058 public function getEmailAuthenticationTimestamp() {
3060 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
3061 return $this->mEmailAuthenticated
;
3065 * Set the user's e-mail address
3066 * @param string $str New e-mail address
3068 public function setEmail( $str ) {
3070 if ( $str == $this->mEmail
) {
3073 $this->invalidateEmail();
3074 $this->mEmail
= $str;
3075 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
3079 * Set the user's e-mail address and a confirmation mail if needed.
3082 * @param string $str New e-mail address
3085 public function setEmailWithConfirmation( $str ) {
3086 global $wgEnableEmail, $wgEmailAuthentication;
3088 if ( !$wgEnableEmail ) {
3089 return Status
::newFatal( 'emaildisabled' );
3092 $oldaddr = $this->getEmail();
3093 if ( $str === $oldaddr ) {
3094 return Status
::newGood( true );
3097 $type = $oldaddr != '' ?
'changed' : 'set';
3098 $notificationResult = null;
3100 if ( $wgEmailAuthentication && $type === 'changed' ) {
3101 // Send the user an email notifying the user of the change in registered
3102 // email address on their previous email address
3103 $change = $str != '' ?
'changed' : 'removed';
3104 $notificationResult = $this->sendMail(
3105 wfMessage( 'notificationemail_subject_' . $change )->text(),
3106 wfMessage( 'notificationemail_body_' . $change,
3107 $this->getRequest()->getIP(),
3113 $this->setEmail( $str );
3115 if ( $str !== '' && $wgEmailAuthentication ) {
3116 // Send a confirmation request to the new address if needed
3117 $result = $this->sendConfirmationMail( $type );
3119 if ( $notificationResult !== null ) {
3120 $result->merge( $notificationResult );
3123 if ( $result->isGood() ) {
3124 // Say to the caller that a confirmation and notification mail has been sent
3125 $result->value
= 'eauth';
3128 $result = Status
::newGood( true );
3135 * Get the user's real name
3136 * @return string User's real name
3138 public function getRealName() {
3139 if ( !$this->isItemLoaded( 'realname' ) ) {
3143 return $this->mRealName
;
3147 * Set the user's real name
3148 * @param string $str New real name
3150 public function setRealName( $str ) {
3152 $this->mRealName
= $str;
3156 * Get the user's current setting for a given option.
3158 * @param string $oname The option to check
3159 * @param string|array|null $defaultOverride A default value returned if the option does not exist
3160 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
3161 * @return string|array|int|null User's current value for the option
3162 * @see getBoolOption()
3163 * @see getIntOption()
3165 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
3166 global $wgHiddenPrefs;
3167 $this->loadOptions();
3169 # We want 'disabled' preferences to always behave as the default value for
3170 # users, even if they have set the option explicitly in their settings (ie they
3171 # set it, and then it was disabled removing their ability to change it). But
3172 # we don't want to erase the preferences in the database in case the preference
3173 # is re-enabled again. So don't touch $mOptions, just override the returned value
3174 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
3175 return self
::getDefaultOption( $oname );
3178 if ( array_key_exists( $oname, $this->mOptions
) ) {
3179 return $this->mOptions
[$oname];
3182 return $defaultOverride;
3186 * Get all user's options
3188 * @param int $flags Bitwise combination of:
3189 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
3190 * to the default value. (Since 1.25)
3193 public function getOptions( $flags = 0 ) {
3194 global $wgHiddenPrefs;
3195 $this->loadOptions();
3196 $options = $this->mOptions
;
3198 # We want 'disabled' preferences to always behave as the default value for
3199 # users, even if they have set the option explicitly in their settings (ie they
3200 # set it, and then it was disabled removing their ability to change it). But
3201 # we don't want to erase the preferences in the database in case the preference
3202 # is re-enabled again. So don't touch $mOptions, just override the returned value
3203 foreach ( $wgHiddenPrefs as $pref ) {
3204 $default = self
::getDefaultOption( $pref );
3205 if ( $default !== null ) {
3206 $options[$pref] = $default;
3210 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
3211 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
3218 * Get the user's current setting for a given option, as a boolean value.
3220 * @param string $oname The option to check
3221 * @return bool User's current value for the option
3224 public function getBoolOption( $oname ) {
3225 return (bool)$this->getOption( $oname );
3229 * Get the user's current setting for a given option, as an integer value.
3231 * @param string $oname The option to check
3232 * @param int $defaultOverride A default value returned if the option does not exist
3233 * @return int User's current value for the option
3236 public function getIntOption( $oname, $defaultOverride = 0 ) {
3237 $val = $this->getOption( $oname );
3239 $val = $defaultOverride;
3241 return intval( $val );
3245 * Set the given option for a user.
3247 * You need to call saveSettings() to actually write to the database.
3249 * @param string $oname The option to set
3250 * @param mixed $val New value to set
3252 public function setOption( $oname, $val ) {
3253 $this->loadOptions();
3255 // Explicitly NULL values should refer to defaults
3256 if ( is_null( $val ) ) {
3257 $val = self
::getDefaultOption( $oname );
3260 $this->mOptions
[$oname] = $val;
3264 * Get a token stored in the preferences (like the watchlist one),
3265 * resetting it if it's empty (and saving changes).
3267 * @param string $oname The option name to retrieve the token from
3268 * @return string|bool User's current value for the option, or false if this option is disabled.
3269 * @see resetTokenFromOption()
3271 * @deprecated since 1.26 Applications should use the OAuth extension
3273 public function getTokenFromOption( $oname ) {
3274 global $wgHiddenPrefs;
3276 $id = $this->getId();
3277 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
3281 $token = $this->getOption( $oname );
3283 // Default to a value based on the user token to avoid space
3284 // wasted on storing tokens for all users. When this option
3285 // is set manually by the user, only then is it stored.
3286 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
3293 * Reset a token stored in the preferences (like the watchlist one).
3294 * *Does not* save user's preferences (similarly to setOption()).
3296 * @param string $oname The option name to reset the token in
3297 * @return string|bool New token value, or false if this option is disabled.
3298 * @see getTokenFromOption()
3301 public function resetTokenFromOption( $oname ) {
3302 global $wgHiddenPrefs;
3303 if ( in_array( $oname, $wgHiddenPrefs ) ) {
3307 $token = MWCryptRand
::generateHex( 40 );
3308 $this->setOption( $oname, $token );
3313 * Return a list of the types of user options currently returned by
3314 * User::getOptionKinds().
3316 * Currently, the option kinds are:
3317 * - 'registered' - preferences which are registered in core MediaWiki or
3318 * by extensions using the UserGetDefaultOptions hook.
3319 * - 'registered-multiselect' - as above, using the 'multiselect' type.
3320 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
3321 * - 'userjs' - preferences with names starting with 'userjs-', intended to
3322 * be used by user scripts.
3323 * - 'special' - "preferences" that are not accessible via User::getOptions
3324 * or User::setOptions.
3325 * - 'unused' - preferences about which MediaWiki doesn't know anything.
3326 * These are usually legacy options, removed in newer versions.
3328 * The API (and possibly others) use this function to determine the possible
3329 * option types for validation purposes, so make sure to update this when a
3330 * new option kind is added.
3332 * @see User::getOptionKinds
3333 * @return array Option kinds
3335 public static function listOptionKinds() {
3338 'registered-multiselect',
3339 'registered-checkmatrix',
3347 * Return an associative array mapping preferences keys to the kind of a preference they're
3348 * used for. Different kinds are handled differently when setting or reading preferences.
3350 * See User::listOptionKinds for the list of valid option types that can be provided.
3352 * @see User::listOptionKinds
3353 * @param IContextSource $context
3354 * @param array|null $options Assoc. array with options keys to check as keys.
3355 * Defaults to $this->mOptions.
3356 * @return array The key => kind mapping data
3358 public function getOptionKinds( IContextSource
$context, $options = null ) {
3359 $this->loadOptions();
3360 if ( $options === null ) {
3361 $options = $this->mOptions
;
3364 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
3365 $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
3368 // Pull out the "special" options, so they don't get converted as
3369 // multiselect or checkmatrix.
3370 $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
3371 foreach ( $specialOptions as $name => $value ) {
3372 unset( $prefs[$name] );
3375 // Multiselect and checkmatrix options are stored in the database with
3376 // one key per option, each having a boolean value. Extract those keys.
3377 $multiselectOptions = [];
3378 foreach ( $prefs as $name => $info ) {
3379 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3380 ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField
::class ) ) {
3381 $opts = HTMLFormField
::flattenOptions( $info['options'] );
3382 $prefix = $info['prefix'] ??
$name;
3384 foreach ( $opts as $value ) {
3385 $multiselectOptions["$prefix$value"] = true;
3388 unset( $prefs[$name] );
3391 $checkmatrixOptions = [];
3392 foreach ( $prefs as $name => $info ) {
3393 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3394 ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix
::class ) ) {
3395 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3396 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3397 $prefix = $info['prefix'] ??
$name;
3399 foreach ( $columns as $column ) {
3400 foreach ( $rows as $row ) {
3401 $checkmatrixOptions["$prefix$column-$row"] = true;
3405 unset( $prefs[$name] );
3409 // $value is ignored
3410 foreach ( $options as $key => $value ) {
3411 if ( isset( $prefs[$key] ) ) {
3412 $mapping[$key] = 'registered';
3413 } elseif ( isset( $multiselectOptions[$key] ) ) {
3414 $mapping[$key] = 'registered-multiselect';
3415 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3416 $mapping[$key] = 'registered-checkmatrix';
3417 } elseif ( isset( $specialOptions[$key] ) ) {
3418 $mapping[$key] = 'special';
3419 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3420 $mapping[$key] = 'userjs';
3422 $mapping[$key] = 'unused';
3430 * Reset certain (or all) options to the site defaults
3432 * The optional parameter determines which kinds of preferences will be reset.
3433 * Supported values are everything that can be reported by getOptionKinds()
3434 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3436 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3437 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3438 * for backwards-compatibility.
3439 * @param IContextSource|null $context Context source used when $resetKinds
3440 * does not contain 'all', passed to getOptionKinds().
3441 * Defaults to RequestContext::getMain() when null.
3443 public function resetOptions(
3444 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3445 IContextSource
$context = null
3448 $defaultOptions = self
::getDefaultOptions();
3450 if ( !is_array( $resetKinds ) ) {
3451 $resetKinds = [ $resetKinds ];
3454 if ( in_array( 'all', $resetKinds ) ) {
3455 $newOptions = $defaultOptions;
3457 if ( $context === null ) {
3458 $context = RequestContext
::getMain();
3461 $optionKinds = $this->getOptionKinds( $context );
3462 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3465 // Use default values for the options that should be deleted, and
3466 // copy old values for the ones that shouldn't.
3467 foreach ( $this->mOptions
as $key => $value ) {
3468 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3469 if ( array_key_exists( $key, $defaultOptions ) ) {
3470 $newOptions[$key] = $defaultOptions[$key];
3473 $newOptions[$key] = $value;
3478 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3480 $this->mOptions
= $newOptions;
3481 $this->mOptionsLoaded
= true;
3485 * Get the user's preferred date format.
3486 * @return string User's preferred date format
3488 public function getDatePreference() {
3489 // Important migration for old data rows
3490 if ( is_null( $this->mDatePreference
) ) {
3492 $value = $this->getOption( 'date' );
3493 $map = $wgLang->getDatePreferenceMigrationMap();
3494 if ( isset( $map[$value] ) ) {
3495 $value = $map[$value];
3497 $this->mDatePreference
= $value;
3499 return $this->mDatePreference
;
3503 * Determine based on the wiki configuration and the user's options,
3504 * whether this user must be over HTTPS no matter what.
3508 public function requiresHTTPS() {
3509 global $wgSecureLogin;
3510 if ( !$wgSecureLogin ) {
3514 $https = $this->getBoolOption( 'prefershttps' );
3515 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3517 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3524 * Get the user preferred stub threshold
3528 public function getStubThreshold() {
3529 global $wgMaxArticleSize; # Maximum article size, in Kb
3530 $threshold = $this->getIntOption( 'stubthreshold' );
3531 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3532 // If they have set an impossible value, disable the preference
3533 // so we can use the parser cache again.
3540 * Get the permissions this user has.
3541 * @return string[] permission names
3543 public function getRights() {
3544 if ( is_null( $this->mRights
) ) {
3545 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3546 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3548 // Deny any rights denied by the user's session, unless this
3549 // endpoint has no sessions.
3550 if ( !defined( 'MW_NO_SESSION' ) ) {
3551 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3552 if ( $allowedRights !== null ) {
3553 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3557 Hooks
::run( 'UserGetRightsRemove', [ $this, &$this->mRights
] );
3558 // Force reindexation of rights when a hook has unset one of them
3559 $this->mRights
= array_values( array_unique( $this->mRights
) );
3561 // If block disables login, we should also remove any
3562 // extra rights blocked users might have, in case the
3563 // blocked user has a pre-existing session (T129738).
3564 // This is checked here for cases where people only call
3565 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3566 // to give a better error message in the common case.
3567 $config = RequestContext
::getMain()->getConfig();
3569 $this->isLoggedIn() &&
3570 $config->get( 'BlockDisablesLogin' ) &&
3574 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3577 return $this->mRights
;
3581 * Get the list of explicit group memberships this user has.
3582 * The implicit * and user groups are not included.
3584 * @return string[] Array of internal group names (sorted since 1.33)
3586 public function getGroups() {
3588 $this->loadGroups();
3589 return array_keys( $this->mGroupMemberships
);
3593 * Get the list of explicit group memberships this user has, stored as
3594 * UserGroupMembership objects. Implicit groups are not included.
3596 * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
3599 public function getGroupMemberships() {
3601 $this->loadGroups();
3602 return $this->mGroupMemberships
;
3606 * Get the list of implicit group memberships this user has.
3607 * This includes all explicit groups, plus 'user' if logged in,
3608 * '*' for all accounts, and autopromoted groups
3609 * @param bool $recache Whether to avoid the cache
3610 * @return array Array of String internal group names
3612 public function getEffectiveGroups( $recache = false ) {
3613 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3614 $this->mEffectiveGroups
= array_unique( array_merge(
3615 $this->getGroups(), // explicit groups
3616 $this->getAutomaticGroups( $recache ) // implicit groups
3618 // Avoid PHP 7.1 warning of passing $this by reference
3620 // Hook for additional groups
3621 Hooks
::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups
] );
3622 // Force reindexation of groups when a hook has unset one of them
3623 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3625 return $this->mEffectiveGroups
;
3629 * Get the list of implicit group memberships this user has.
3630 * This includes 'user' if logged in, '*' for all accounts,
3631 * and autopromoted groups
3632 * @param bool $recache Whether to avoid the cache
3633 * @return array Array of String internal group names
3635 public function getAutomaticGroups( $recache = false ) {
3636 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3637 $this->mImplicitGroups
= [ '*' ];
3638 if ( $this->getId() ) {
3639 $this->mImplicitGroups
[] = 'user';
3641 $this->mImplicitGroups
= array_unique( array_merge(
3642 $this->mImplicitGroups
,
3643 Autopromote
::getAutopromoteGroups( $this )
3647 // Assure data consistency with rights/groups,
3648 // as getEffectiveGroups() depends on this function
3649 $this->mEffectiveGroups
= null;
3652 return $this->mImplicitGroups
;
3656 * Returns the groups the user has belonged to.
3658 * The user may still belong to the returned groups. Compare with getGroups().
3660 * The function will not return groups the user had belonged to before MW 1.17
3662 * @return array Names of the groups the user has belonged to.
3664 public function getFormerGroups() {
3667 if ( is_null( $this->mFormerGroups
) ) {
3668 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3669 ?
wfGetDB( DB_MASTER
)
3670 : wfGetDB( DB_REPLICA
);
3671 $res = $db->select( 'user_former_groups',
3673 [ 'ufg_user' => $this->mId
],
3675 $this->mFormerGroups
= [];
3676 foreach ( $res as $row ) {
3677 $this->mFormerGroups
[] = $row->ufg_group
;
3681 return $this->mFormerGroups
;
3685 * Get the user's edit count.
3686 * @return int|null Null for anonymous users
3688 public function getEditCount() {
3689 if ( !$this->getId() ) {
3693 if ( $this->mEditCount
=== null ) {
3694 /* Populate the count, if it has not been populated yet */
3695 $dbr = wfGetDB( DB_REPLICA
);
3696 // check if the user_editcount field has been initialized
3697 $count = $dbr->selectField(
3698 'user', 'user_editcount',
3699 [ 'user_id' => $this->mId
],
3703 if ( $count === null ) {
3704 // it has not been initialized. do so.
3705 $count = $this->initEditCountInternal();
3707 $this->mEditCount
= $count;
3709 return (int)$this->mEditCount
;
3713 * Add the user to the given group. This takes immediate effect.
3714 * If the user is already in the group, the expiry time will be updated to the new
3715 * expiry time. (If $expiry is omitted or null, the membership will be altered to
3718 * @param string $group Name of the group to add
3719 * @param string|null $expiry Optional expiry timestamp in any format acceptable to
3720 * wfTimestamp(), or null if the group assignment should not expire
3723 public function addGroup( $group, $expiry = null ) {
3725 $this->loadGroups();
3728 $expiry = wfTimestamp( TS_MW
, $expiry );
3731 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
3735 // create the new UserGroupMembership and put it in the DB
3736 $ugm = new UserGroupMembership( $this->mId
, $group, $expiry );
3737 if ( !$ugm->insert( true ) ) {
3741 $this->mGroupMemberships
[$group] = $ugm;
3743 // Refresh the groups caches, and clear the rights cache so it will be
3744 // refreshed on the next call to $this->getRights().
3745 $this->getEffectiveGroups( true );
3746 $this->mRights
= null;
3748 $this->invalidateCache();
3754 * Remove the user from the given group.
3755 * This takes immediate effect.
3756 * @param string $group Name of the group to remove
3759 public function removeGroup( $group ) {
3762 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3766 $ugm = UserGroupMembership
::getMembership( $this->mId
, $group );
3767 // delete the membership entry
3768 if ( !$ugm ||
!$ugm->delete() ) {
3772 $this->loadGroups();
3773 unset( $this->mGroupMemberships
[$group] );
3775 // Refresh the groups caches, and clear the rights cache so it will be
3776 // refreshed on the next call to $this->getRights().
3777 $this->getEffectiveGroups( true );
3778 $this->mRights
= null;
3780 $this->invalidateCache();
3786 * Get whether the user is logged in
3789 public function isLoggedIn() {
3790 return $this->getId() != 0;
3794 * Get whether the user is anonymous
3797 public function isAnon() {
3798 return !$this->isLoggedIn();
3802 * @return bool Whether this user is flagged as being a bot role account
3805 public function isBot() {
3806 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3811 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3817 * Check if user is allowed to access a feature / make an action
3819 * @param string $permissions,... Permissions to test
3820 * @return bool True if user is allowed to perform *any* of the given actions
3822 public function isAllowedAny() {
3823 $permissions = func_get_args();
3824 foreach ( $permissions as $permission ) {
3825 if ( $this->isAllowed( $permission ) ) {
3834 * @param string $permissions,... Permissions to test
3835 * @return bool True if the user is allowed to perform *all* of the given actions
3837 public function isAllowedAll() {
3838 $permissions = func_get_args();
3839 foreach ( $permissions as $permission ) {
3840 if ( !$this->isAllowed( $permission ) ) {
3848 * Internal mechanics of testing a permission
3849 * @param string $action
3852 public function isAllowed( $action = '' ) {
3853 if ( $action === '' ) {
3854 return true; // In the spirit of DWIM
3856 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3857 // by misconfiguration: 0 == 'foo'
3858 return in_array( $action, $this->getRights(), true );
3862 * Check whether to enable recent changes patrol features for this user
3863 * @return bool True or false
3865 public function useRCPatrol() {
3866 global $wgUseRCPatrol;
3867 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3871 * Check whether to enable new pages patrol features for this user
3872 * @return bool True or false
3874 public function useNPPatrol() {
3875 global $wgUseRCPatrol, $wgUseNPPatrol;
3877 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3878 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3883 * Check whether to enable new files patrol features for this user
3884 * @return bool True or false
3886 public function useFilePatrol() {
3887 global $wgUseRCPatrol, $wgUseFilePatrol;
3889 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3890 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3895 * Get the WebRequest object to use with this object
3897 * @return WebRequest
3899 public function getRequest() {
3900 if ( $this->mRequest
) {
3901 return $this->mRequest
;
3909 * Check the watched status of an article.
3910 * @since 1.22 $checkRights parameter added
3911 * @param Title $title Title of the article to look at
3912 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3913 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3916 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3917 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3918 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3925 * @since 1.22 $checkRights parameter added
3926 * @param Title $title Title of the article to look at
3927 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3928 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3930 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3931 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3932 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3934 [ $title->getSubjectPage(), $title->getTalkPage() ]
3937 $this->invalidateCache();
3941 * Stop watching an article.
3942 * @since 1.22 $checkRights parameter added
3943 * @param Title $title Title of the article to look at
3944 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3945 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3947 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3948 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3949 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3950 $store->removeWatch( $this, $title->getSubjectPage() );
3951 $store->removeWatch( $this, $title->getTalkPage() );
3953 $this->invalidateCache();
3957 * Clear the user's notification timestamp for the given title.
3958 * If e-notif e-mails are on, they will receive notification mails on
3959 * the next change of the page if it's watched etc.
3960 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3961 * @param Title &$title Title of the article to look at
3962 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3964 public function clearNotification( &$title, $oldid = 0 ) {
3965 global $wgUseEnotif, $wgShowUpdatedMarker;
3967 // Do nothing if the database is locked to writes
3968 if ( wfReadOnly() ) {
3972 // Do nothing if not allowed to edit the watchlist
3973 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3977 // If we're working on user's talk page, we should update the talk page message indicator
3978 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3979 // Avoid PHP 7.1 warning of passing $this by reference
3981 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
3985 // Try to update the DB post-send and only if needed...
3986 DeferredUpdates
::addCallableUpdate( function () use ( $title, $oldid ) {
3987 if ( !$this->getNewtalk() ) {
3988 return; // no notifications to clear
3991 // Delete the last notifications (they stack up)
3992 $this->setNewtalk( false );
3994 // If there is a new, unseen, revision, use its timestamp
3996 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
3999 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
4004 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4008 if ( $this->isAnon() ) {
4009 // Nothing else to do...
4013 // Only update the timestamp if the page is being watched.
4014 // The query to find out if it is watched is cached both in memcached and per-invocation,
4015 // and when it does have to be executed, it can be on a replica DB
4016 // If this is the user's newtalk page, we always update the timestamp
4018 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
4022 MediaWikiServices
::getInstance()->getWatchedItemStore()
4023 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
4027 * Resets all of the given user's page-change notification timestamps.
4028 * If e-notif e-mails are on, they will receive notification mails on
4029 * the next change of any watched page.
4030 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
4032 public function clearAllNotifications() {
4033 global $wgUseEnotif, $wgShowUpdatedMarker;
4034 // Do nothing if not allowed to edit the watchlist
4035 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
4039 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4040 $this->setNewtalk( false );
4044 $id = $this->getId();
4049 $watchedItemStore = MediaWikiServices
::getInstance()->getWatchedItemStore();
4050 $watchedItemStore->resetAllNotificationTimestampsForUser( $this );
4052 // We also need to clear here the "you have new message" notification for the own
4053 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
4057 * Compute experienced level based on edit count and registration date.
4059 * @return string 'newcomer', 'learner', or 'experienced'
4061 public function getExperienceLevel() {
4062 global $wgLearnerEdits,
4063 $wgExperiencedUserEdits,
4064 $wgLearnerMemberSince,
4065 $wgExperiencedUserMemberSince;
4067 if ( $this->isAnon() ) {
4071 $editCount = $this->getEditCount();
4072 $registration = $this->getRegistration();
4074 $learnerRegistration = wfTimestamp( TS_MW
, $now - $wgLearnerMemberSince * 86400 );
4075 $experiencedRegistration = wfTimestamp( TS_MW
, $now - $wgExperiencedUserMemberSince * 86400 );
4077 if ( $editCount < $wgLearnerEdits ||
4078 $registration > $learnerRegistration ) {
4082 if ( $editCount > $wgExperiencedUserEdits &&
4083 $registration <= $experiencedRegistration
4085 return 'experienced';
4092 * Persist this user's session (e.g. set cookies)
4094 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
4096 * @param bool|null $secure Whether to force secure/insecure cookies or use default
4097 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
4099 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
4101 if ( $this->mId
== 0 ) {
4105 $session = $this->getRequest()->getSession();
4106 if ( $request && $session->getRequest() !== $request ) {
4107 $session = $session->sessionWithRequest( $request );
4109 $delay = $session->delaySave();
4111 if ( !$session->getUser()->equals( $this ) ) {
4112 if ( !$session->canSetUser() ) {
4113 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4114 ->warning( __METHOD__
.
4115 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
4119 $session->setUser( $this );
4122 $session->setRememberUser( $rememberMe );
4123 if ( $secure !== null ) {
4124 $session->setForceHTTPS( $secure );
4127 $session->persist();
4129 ScopedCallback
::consume( $delay );
4133 * Log this user out.
4135 public function logout() {
4136 // Avoid PHP 7.1 warning of passing $this by reference
4138 if ( Hooks
::run( 'UserLogout', [ &$user ] ) ) {
4144 * Clear the user's session, and reset the instance cache.
4147 public function doLogout() {
4148 $session = $this->getRequest()->getSession();
4149 if ( !$session->canSetUser() ) {
4150 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4151 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
4152 $error = 'immutable';
4153 } elseif ( !$session->getUser()->equals( $this ) ) {
4154 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4155 ->warning( __METHOD__
.
4156 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
4158 // But we still may as well make this user object anon
4159 $this->clearInstanceCache( 'defaults' );
4160 $error = 'wronguser';
4162 $this->clearInstanceCache( 'defaults' );
4163 $delay = $session->delaySave();
4164 $session->unpersist(); // Clear cookies (T127436)
4165 $session->setLoggedOutTimestamp( time() );
4166 $session->setUser( new User
);
4167 $session->set( 'wsUserID', 0 ); // Other code expects this
4168 $session->resetAllTokens();
4169 ScopedCallback
::consume( $delay );
4172 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
4173 'event' => 'logout',
4174 'successful' => $error === false,
4175 'status' => $error ?
: 'success',
4180 * Save this user's settings into the database.
4181 * @todo Only rarely do all these fields need to be set!
4183 public function saveSettings() {
4184 if ( wfReadOnly() ) {
4185 // @TODO: caller should deal with this instead!
4186 // This should really just be an exception.
4187 MWExceptionHandler
::logException( new DBExpectedError(
4189 "Could not update user with ID '{$this->mId}'; DB is read-only."
4195 if ( $this->mId
== 0 ) {
4199 // Get a new user_touched that is higher than the old one.
4200 // This will be used for a CAS check as a last-resort safety
4201 // check against race conditions and replica DB lag.
4202 $newTouched = $this->newTouchedTimestamp();
4204 $dbw = wfGetDB( DB_MASTER
);
4205 $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $newTouched ) {
4206 global $wgActorTableSchemaMigrationStage;
4208 $dbw->update( 'user',
4210 'user_name' => $this->mName
,
4211 'user_real_name' => $this->mRealName
,
4212 'user_email' => $this->mEmail
,
4213 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4214 'user_touched' => $dbw->timestamp( $newTouched ),
4215 'user_token' => strval( $this->mToken
),
4216 'user_email_token' => $this->mEmailToken
,
4217 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
4218 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
4219 'user_id' => $this->mId
,
4223 if ( !$dbw->affectedRows() ) {
4224 // Maybe the problem was a missed cache update; clear it to be safe
4225 $this->clearSharedCache( 'refresh' );
4226 // User was changed in the meantime or loaded with stale data
4227 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
4228 LoggerFactory
::getInstance( 'preferences' )->warning(
4229 "CAS update failed on user_touched for user ID '{user_id}' ({db_flag} read)",
4230 [ 'user_id' => $this->mId
, 'db_flag' => $from ]
4232 throw new MWException( "CAS update failed on user_touched. " .
4233 "The version of the user to be saved is older than the current version."
4237 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4240 [ 'actor_name' => $this->mName
],
4241 [ 'actor_user' => $this->mId
],
4247 $this->mTouched
= $newTouched;
4248 $this->saveOptions();
4250 Hooks
::run( 'UserSaveSettings', [ $this ] );
4251 $this->clearSharedCache();
4252 $this->getUserPage()->purgeSquid();
4256 * If only this user's username is known, and it exists, return the user ID.
4258 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
4261 public function idForName( $flags = 0 ) {
4262 $s = trim( $this->getName() );
4267 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
4268 ?
wfGetDB( DB_MASTER
)
4269 : wfGetDB( DB_REPLICA
);
4271 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
4272 ?
[ 'LOCK IN SHARE MODE' ]
4275 $id = $db->selectField( 'user',
4276 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
4282 * Add a user to the database, return the user object
4284 * @param string $name Username to add
4285 * @param array $params Array of Strings Non-default parameters to save to
4286 * the database as user_* fields:
4287 * - email: The user's email address.
4288 * - email_authenticated: The email authentication timestamp.
4289 * - real_name: The user's real name.
4290 * - options: An associative array of non-default options.
4291 * - token: Random authentication token. Do not set.
4292 * - registration: Registration timestamp. Do not set.
4294 * @return User|null User object, or null if the username already exists.
4296 public static function createNew( $name, $params = [] ) {
4297 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
4298 if ( isset( $params[$field] ) ) {
4299 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
4300 unset( $params[$field] );
4306 $user->setToken(); // init token
4307 if ( isset( $params['options'] ) ) {
4308 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
4309 unset( $params['options'] );
4311 $dbw = wfGetDB( DB_MASTER
);
4313 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4316 'user_name' => $name,
4317 'user_password' => $noPass,
4318 'user_newpassword' => $noPass,
4319 'user_email' => $user->mEmail
,
4320 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
4321 'user_real_name' => $user->mRealName
,
4322 'user_token' => strval( $user->mToken
),
4323 'user_registration' => $dbw->timestamp( $user->mRegistration
),
4324 'user_editcount' => 0,
4325 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4327 foreach ( $params as $name => $value ) {
4328 $fields["user_$name"] = $value;
4331 return $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $fields ) {
4332 $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
4333 if ( $dbw->affectedRows() ) {
4334 $newUser = self
::newFromId( $dbw->insertId() );
4335 $newUser->mName
= $fields['user_name'];
4336 $newUser->updateActorId( $dbw );
4337 // Load the user from master to avoid replica lag
4338 $newUser->load( self
::READ_LATEST
);
4347 * Add this existing user object to the database. If the user already
4348 * exists, a fatal status object is returned, and the user object is
4349 * initialised with the data from the database.
4351 * Previously, this function generated a DB error due to a key conflict
4352 * if the user already existed. Many extension callers use this function
4353 * in code along the lines of:
4355 * $user = User::newFromName( $name );
4356 * if ( !$user->isLoggedIn() ) {
4357 * $user->addToDatabase();
4359 * // do something with $user...
4361 * However, this was vulnerable to a race condition (T18020). By
4362 * initialising the user object if the user exists, we aim to support this
4363 * calling sequence as far as possible.
4365 * Note that if the user exists, this function will acquire a write lock,
4366 * so it is still advisable to make the call conditional on isLoggedIn(),
4367 * and to commit the transaction after calling.
4369 * @throws MWException
4372 public function addToDatabase() {
4374 if ( !$this->mToken
) {
4375 $this->setToken(); // init token
4378 if ( !is_string( $this->mName
) ) {
4379 throw new RuntimeException( "User name field is not set." );
4382 $this->mTouched
= $this->newTouchedTimestamp();
4384 $dbw = wfGetDB( DB_MASTER
);
4385 $status = $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) {
4386 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4387 $dbw->insert( 'user',
4389 'user_name' => $this->mName
,
4390 'user_password' => $noPass,
4391 'user_newpassword' => $noPass,
4392 'user_email' => $this->mEmail
,
4393 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4394 'user_real_name' => $this->mRealName
,
4395 'user_token' => strval( $this->mToken
),
4396 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4397 'user_editcount' => 0,
4398 'user_touched' => $dbw->timestamp( $this->mTouched
),
4402 if ( !$dbw->affectedRows() ) {
4403 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4404 $this->mId
= $dbw->selectField(
4407 [ 'user_name' => $this->mName
],
4409 [ 'LOCK IN SHARE MODE' ]
4413 if ( $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4418 throw new MWException( $fname . ": hit a key conflict attempting " .
4419 "to insert user '{$this->mName}' row, but it was not present in select!" );
4421 return Status
::newFatal( 'userexists' );
4423 $this->mId
= $dbw->insertId();
4424 self
::$idCacheByName[$this->mName
] = $this->mId
;
4425 $this->updateActorId( $dbw );
4427 return Status
::newGood();
4429 if ( !$status->isGood() ) {
4433 // Clear instance cache other than user table data and actor, which is already accurate
4434 $this->clearInstanceCache();
4436 $this->saveOptions();
4437 return Status
::newGood();
4441 * Update the actor ID after an insert
4442 * @param IDatabase $dbw Writable database handle
4444 private function updateActorId( IDatabase
$dbw ) {
4445 global $wgActorTableSchemaMigrationStage;
4447 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4450 [ 'actor_user' => $this->mId
, 'actor_name' => $this->mName
],
4453 $this->mActorId
= (int)$dbw->insertId();
4458 * If this user is logged-in and blocked,
4459 * block any IP address they've successfully logged in from.
4460 * @return bool A block was spread
4462 public function spreadAnyEditBlock() {
4463 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4464 return $this->spreadBlock();
4471 * If this (non-anonymous) user is blocked,
4472 * block the IP address they've successfully logged in from.
4473 * @return bool A block was spread
4475 protected function spreadBlock() {
4476 wfDebug( __METHOD__
. "()\n" );
4478 if ( $this->mId
== 0 ) {
4482 $userblock = Block
::newFromTarget( $this->getName() );
4483 if ( !$userblock ) {
4487 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4491 * Get whether the user is explicitly blocked from account creation.
4492 * @return bool|Block
4494 public function isBlockedFromCreateAccount() {
4495 $this->getBlockedStatus();
4496 if ( $this->mBlock
&& $this->mBlock
->appliesToRight( 'createaccount' ) ) {
4497 return $this->mBlock
;
4500 # T15611: if the IP address the user is trying to create an account from is
4501 # blocked with createaccount disabled, prevent new account creation there even
4502 # when the user is logged in
4503 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4504 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4506 return $this->mBlockedFromCreateAccount
instanceof Block
4507 && $this->mBlockedFromCreateAccount
->appliesToRight( 'createaccount' )
4508 ?
$this->mBlockedFromCreateAccount
4513 * Get whether the user is blocked from using Special:Emailuser.
4516 public function isBlockedFromEmailuser() {
4517 $this->getBlockedStatus();
4518 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'sendemail' );
4522 * Get whether the user is blocked from using Special:Upload
4527 public function isBlockedFromUpload() {
4528 $this->getBlockedStatus();
4529 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'upload' );
4533 * Get whether the user is allowed to create an account.
4536 public function isAllowedToCreateAccount() {
4537 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4541 * Get this user's personal page title.
4543 * @return Title User's personal page title
4545 public function getUserPage() {
4546 return Title
::makeTitle( NS_USER
, $this->getName() );
4550 * Get this user's talk page title.
4552 * @return Title User's talk page title
4554 public function getTalkPage() {
4555 $title = $this->getUserPage();
4556 return $title->getTalkPage();
4560 * Determine whether the user is a newbie. Newbies are either
4561 * anonymous IPs, or the most recently created accounts.
4564 public function isNewbie() {
4565 return !$this->isAllowed( 'autoconfirmed' );
4569 * Check to see if the given clear-text password is one of the accepted passwords
4570 * @deprecated since 1.27, use AuthManager instead
4571 * @param string $password User password
4572 * @return bool True if the given password is correct, otherwise False
4574 public function checkPassword( $password ) {
4575 wfDeprecated( __METHOD__
, '1.27' );
4577 $manager = AuthManager
::singleton();
4578 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4579 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4581 'username' => $this->getName(),
4582 'password' => $password,
4585 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4586 switch ( $res->status
) {
4587 case AuthenticationResponse
::PASS
:
4589 case AuthenticationResponse
::FAIL
:
4590 // Hope it's not a PreAuthenticationProvider that failed...
4591 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4592 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4595 throw new BadMethodCallException(
4596 'AuthManager returned a response unsupported by ' . __METHOD__
4602 * Check if the given clear-text password matches the temporary password
4603 * sent by e-mail for password reset operations.
4605 * @deprecated since 1.27, use AuthManager instead
4606 * @param string $plaintext
4607 * @return bool True if matches, false otherwise
4609 public function checkTemporaryPassword( $plaintext ) {
4610 wfDeprecated( __METHOD__
, '1.27' );
4611 // Can't check the temporary password individually.
4612 return $this->checkPassword( $plaintext );
4616 * Initialize (if necessary) and return a session token value
4617 * which can be used in edit forms to show that the user's
4618 * login credentials aren't being hijacked with a foreign form
4622 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4623 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4624 * @return MediaWiki\Session\Token The new edit token
4626 public function getEditTokenObject( $salt = '', $request = null ) {
4627 if ( $this->isAnon() ) {
4628 return new LoggedOutEditToken();
4632 $request = $this->getRequest();
4634 return $request->getSession()->getToken( $salt );
4638 * Initialize (if necessary) and return a session token value
4639 * which can be used in edit forms to show that the user's
4640 * login credentials aren't being hijacked with a foreign form
4643 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4646 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4647 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4648 * @return string The new edit token
4650 public function getEditToken( $salt = '', $request = null ) {
4651 return $this->getEditTokenObject( $salt, $request )->toString();
4655 * Check given value against the token value stored in the session.
4656 * A match should confirm that the form was submitted from the
4657 * user's own login session, not a form submission from a third-party
4660 * @param string $val Input value to compare
4661 * @param string|array $salt Optional function-specific data for hashing
4662 * @param WebRequest|null $request Object to use or null to use $wgRequest
4663 * @param int|null $maxage Fail tokens older than this, in seconds
4664 * @return bool Whether the token matches
4666 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4667 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4671 * Check given value against the token value stored in the session,
4672 * ignoring the suffix.
4674 * @param string $val Input value to compare
4675 * @param string|array $salt Optional function-specific data for hashing
4676 * @param WebRequest|null $request Object to use or null to use $wgRequest
4677 * @param int|null $maxage Fail tokens older than this, in seconds
4678 * @return bool Whether the token matches
4680 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4681 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4682 return $this->matchEditToken( $val, $salt, $request, $maxage );
4686 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4687 * mail to the user's given address.
4689 * @param string $type Message to send, either "created", "changed" or "set"
4692 public function sendConfirmationMail( $type = 'created' ) {
4694 $expiration = null; // gets passed-by-ref and defined in next line.
4695 $token = $this->confirmationToken( $expiration );
4696 $url = $this->confirmationTokenUrl( $token );
4697 $invalidateURL = $this->invalidationTokenUrl( $token );
4698 $this->saveSettings();
4700 if ( $type == 'created' ||
$type === false ) {
4701 $message = 'confirmemail_body';
4703 } elseif ( $type === true ) {
4704 $message = 'confirmemail_body_changed';
4707 // Messages: confirmemail_body_changed, confirmemail_body_set
4708 $message = 'confirmemail_body_' . $type;
4712 'subject' => wfMessage( 'confirmemail_subject' )->text(),
4713 'body' => wfMessage( $message,
4714 $this->getRequest()->getIP(),
4717 $wgLang->userTimeAndDate( $expiration, $this ),
4719 $wgLang->userDate( $expiration, $this ),
4720 $wgLang->userTime( $expiration, $this ) )->text(),
4726 'ip' => $this->getRequest()->getIP(),
4727 'confirmURL' => $url,
4728 'invalidateURL' => $invalidateURL,
4729 'expiration' => $expiration
4732 Hooks
::run( 'UserSendConfirmationMail', [ $this, &$mail, $info ] );
4733 return $this->sendMail( $mail['subject'], $mail['body'], $mail['from'], $mail['replyTo'] );
4737 * Send an e-mail to this user's account. Does not check for
4738 * confirmed status or validity.
4740 * @param string $subject Message subject
4741 * @param string $body Message body
4742 * @param User|null $from Optional sending user; if unspecified, default
4743 * $wgPasswordSender will be used.
4744 * @param MailAddress|null $replyto Reply-To address
4747 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4748 global $wgPasswordSender;
4750 if ( $from instanceof User
) {
4751 $sender = MailAddress
::newFromUser( $from );
4753 $sender = new MailAddress( $wgPasswordSender,
4754 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4756 $to = MailAddress
::newFromUser( $this );
4758 return UserMailer
::send( $to, $sender, $subject, $body, [
4759 'replyTo' => $replyto,
4764 * Generate, store, and return a new e-mail confirmation code.
4765 * A hash (unsalted, since it's used as a key) is stored.
4767 * @note Call saveSettings() after calling this function to commit
4768 * this change to the database.
4770 * @param string &$expiration Accepts the expiration time
4771 * @return string New token
4773 protected function confirmationToken( &$expiration ) {
4774 global $wgUserEmailConfirmationTokenExpiry;
4776 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4777 $expiration = wfTimestamp( TS_MW
, $expires );
4779 $token = MWCryptRand
::generateHex( 32 );
4780 $hash = md5( $token );
4781 $this->mEmailToken
= $hash;
4782 $this->mEmailTokenExpires
= $expiration;
4787 * Return a URL the user can use to confirm their email address.
4788 * @param string $token Accepts the email confirmation token
4789 * @return string New token URL
4791 protected function confirmationTokenUrl( $token ) {
4792 return $this->getTokenUrl( 'ConfirmEmail', $token );
4796 * Return a URL the user can use to invalidate their email address.
4797 * @param string $token Accepts the email confirmation token
4798 * @return string New token URL
4800 protected function invalidationTokenUrl( $token ) {
4801 return $this->getTokenUrl( 'InvalidateEmail', $token );
4805 * Internal function to format the e-mail validation/invalidation URLs.
4806 * This uses a quickie hack to use the
4807 * hardcoded English names of the Special: pages, for ASCII safety.
4809 * @note Since these URLs get dropped directly into emails, using the
4810 * short English names avoids insanely long URL-encoded links, which
4811 * also sometimes can get corrupted in some browsers/mailers
4812 * (T8957 with Gmail and Internet Explorer).
4814 * @param string $page Special page
4815 * @param string $token
4816 * @return string Formatted URL
4818 protected function getTokenUrl( $page, $token ) {
4819 // Hack to bypass localization of 'Special:'
4820 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4821 return $title->getCanonicalURL();
4825 * Mark the e-mail address confirmed.
4827 * @note Call saveSettings() after calling this function to commit the change.
4831 public function confirmEmail() {
4832 // Check if it's already confirmed, so we don't touch the database
4833 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4834 if ( !$this->isEmailConfirmed() ) {
4835 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4836 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4842 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4843 * address if it was already confirmed.
4845 * @note Call saveSettings() after calling this function to commit the change.
4846 * @return bool Returns true
4848 public function invalidateEmail() {
4850 $this->mEmailToken
= null;
4851 $this->mEmailTokenExpires
= null;
4852 $this->setEmailAuthenticationTimestamp( null );
4854 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4859 * Set the e-mail authentication timestamp.
4860 * @param string $timestamp TS_MW timestamp
4862 public function setEmailAuthenticationTimestamp( $timestamp ) {
4864 $this->mEmailAuthenticated
= $timestamp;
4865 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4869 * Is this user allowed to send e-mails within limits of current
4870 * site configuration?
4873 public function canSendEmail() {
4874 global $wgEnableEmail, $wgEnableUserEmail;
4875 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4878 $canSend = $this->isEmailConfirmed();
4879 // Avoid PHP 7.1 warning of passing $this by reference
4881 Hooks
::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
4886 * Is this user allowed to receive e-mails within limits of current
4887 * site configuration?
4890 public function canReceiveEmail() {
4891 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4895 * Is this user's e-mail address valid-looking and confirmed within
4896 * limits of the current site configuration?
4898 * @note If $wgEmailAuthentication is on, this may require the user to have
4899 * confirmed their address by returning a code or using a password
4900 * sent to the address from the wiki.
4904 public function isEmailConfirmed() {
4905 global $wgEmailAuthentication;
4907 // Avoid PHP 7.1 warning of passing $this by reference
4910 if ( Hooks
::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
4911 if ( $this->isAnon() ) {
4914 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4917 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4927 * Check whether there is an outstanding request for e-mail confirmation.
4930 public function isEmailConfirmationPending() {
4931 global $wgEmailAuthentication;
4932 return $wgEmailAuthentication &&
4933 !$this->isEmailConfirmed() &&
4934 $this->mEmailToken
&&
4935 $this->mEmailTokenExpires
> wfTimestamp();
4939 * Get the timestamp of account creation.
4941 * @return string|bool|null Timestamp of account creation, false for
4942 * non-existent/anonymous user accounts, or null if existing account
4943 * but information is not in database.
4945 public function getRegistration() {
4946 if ( $this->isAnon() ) {
4950 return $this->mRegistration
;
4954 * Get the timestamp of the first edit
4956 * @return string|bool Timestamp of first edit, or false for
4957 * non-existent/anonymous user accounts.
4959 public function getFirstEditTimestamp() {
4960 return $this->getEditTimestamp( true );
4964 * Get the timestamp of the latest edit
4967 * @return string|bool Timestamp of first edit, or false for
4968 * non-existent/anonymous user accounts.
4970 public function getLatestEditTimestamp() {
4971 return $this->getEditTimestamp( false );
4975 * Get the timestamp of the first or latest edit
4977 * @param bool $first True for the first edit, false for the latest one
4978 * @return string|bool Timestamp of first or latest edit, or false for
4979 * non-existent/anonymous user accounts.
4981 private function getEditTimestamp( $first ) {
4982 if ( $this->getId() == 0 ) {
4983 return false; // anons
4985 $dbr = wfGetDB( DB_REPLICA
);
4986 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
4987 $tsField = isset( $actorWhere['tables']['temp_rev_user'] )
4988 ?
'revactor_timestamp' : 'rev_timestamp';
4989 $sortOrder = $first ?
'ASC' : 'DESC';
4990 $time = $dbr->selectField(
4991 [ 'revision' ] +
$actorWhere['tables'],
4993 [ $actorWhere['conds'] ],
4995 [ 'ORDER BY' => "$tsField $sortOrder" ],
4996 $actorWhere['joins']
4999 return false; // no edits
5001 return wfTimestamp( TS_MW
, $time );
5005 * Get the permissions associated with a given list of groups
5007 * @param array $groups Array of Strings List of internal group names
5008 * @return array Array of Strings List of permission key names for given groups combined
5010 public static function getGroupPermissions( $groups ) {
5011 global $wgGroupPermissions, $wgRevokePermissions;
5013 // grant every granted permission first
5014 foreach ( $groups as $group ) {
5015 if ( isset( $wgGroupPermissions[$group] ) ) {
5016 $rights = array_merge( $rights,
5017 // array_filter removes empty items
5018 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
5021 // now revoke the revoked permissions
5022 foreach ( $groups as $group ) {
5023 if ( isset( $wgRevokePermissions[$group] ) ) {
5024 $rights = array_diff( $rights,
5025 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
5028 return array_unique( $rights );
5032 * Get all the groups who have a given permission
5034 * @param string $role Role to check
5035 * @return array Array of Strings List of internal group names with the given permission
5037 public static function getGroupsWithPermission( $role ) {
5038 global $wgGroupPermissions;
5039 $allowedGroups = [];
5040 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
5041 if ( self
::groupHasPermission( $group, $role ) ) {
5042 $allowedGroups[] = $group;
5045 return $allowedGroups;
5049 * Check, if the given group has the given permission
5051 * If you're wanting to check whether all users have a permission, use
5052 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
5056 * @param string $group Group to check
5057 * @param string $role Role to check
5060 public static function groupHasPermission( $group, $role ) {
5061 global $wgGroupPermissions, $wgRevokePermissions;
5062 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
5063 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
5067 * Check if all users may be assumed to have the given permission
5069 * We generally assume so if the right is granted to '*' and isn't revoked
5070 * on any group. It doesn't attempt to take grants or other extension
5071 * limitations on rights into account in the general case, though, as that
5072 * would require it to always return false and defeat the purpose.
5073 * Specifically, session-based rights restrictions (such as OAuth or bot
5074 * passwords) are applied based on the current session.
5077 * @param string $right Right to check
5080 public static function isEveryoneAllowed( $right ) {
5081 global $wgGroupPermissions, $wgRevokePermissions;
5084 // Use the cached results, except in unit tests which rely on
5085 // being able change the permission mid-request
5086 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
5087 return $cache[$right];
5090 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
5091 $cache[$right] = false;
5095 // If it's revoked anywhere, then everyone doesn't have it
5096 foreach ( $wgRevokePermissions as $rights ) {
5097 if ( isset( $rights[$right] ) && $rights[$right] ) {
5098 $cache[$right] = false;
5103 // Remove any rights that aren't allowed to the global-session user,
5104 // unless there are no sessions for this endpoint.
5105 if ( !defined( 'MW_NO_SESSION' ) ) {
5106 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
5107 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
5108 $cache[$right] = false;
5113 // Allow extensions to say false
5114 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
5115 $cache[$right] = false;
5119 $cache[$right] = true;
5124 * Return the set of defined explicit groups.
5125 * The implicit groups (by default *, 'user' and 'autoconfirmed')
5126 * are not included, as they are defined automatically, not in the database.
5127 * @return array Array of internal group names
5129 public static function getAllGroups() {
5130 global $wgGroupPermissions, $wgRevokePermissions;
5131 return array_values( array_diff(
5132 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
5133 self
::getImplicitGroups()
5138 * Get a list of all available permissions.
5139 * @return string[] Array of permission names
5141 public static function getAllRights() {
5142 if ( self
::$mAllRights === false ) {
5143 global $wgAvailableRights;
5144 if ( count( $wgAvailableRights ) ) {
5145 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
5147 self
::$mAllRights = self
::$mCoreRights;
5149 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
5151 return self
::$mAllRights;
5155 * Get a list of implicit groups
5156 * TODO: Should we deprecate this? It's trivial, but we don't want to encourage use of globals.
5158 * @return array Array of Strings Array of internal group names
5160 public static function getImplicitGroups() {
5161 global $wgImplicitGroups;
5162 return $wgImplicitGroups;
5166 * Get the title of a page describing a particular group
5167 * @deprecated since 1.29 Use UserGroupMembership::getGroupPage instead
5169 * @param string $group Internal group name
5170 * @return Title|bool Title of the page if it exists, false otherwise
5172 public static function getGroupPage( $group ) {
5173 wfDeprecated( __METHOD__
, '1.29' );
5174 return UserGroupMembership
::getGroupPage( $group );
5178 * Create a link to the group in HTML, if available;
5179 * else return the group name.
5180 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5181 * make the link yourself if you need custom text
5183 * @param string $group Internal name of the group
5184 * @param string $text The text of the link
5185 * @return string HTML link to the group
5187 public static function makeGroupLinkHTML( $group, $text = '' ) {
5188 wfDeprecated( __METHOD__
, '1.29' );
5190 if ( $text == '' ) {
5191 $text = UserGroupMembership
::getGroupName( $group );
5193 $title = UserGroupMembership
::getGroupPage( $group );
5195 return MediaWikiServices
::getInstance()
5196 ->getLinkRenderer()->makeLink( $title, $text );
5199 return htmlspecialchars( $text );
5203 * Create a link to the group in Wikitext, if available;
5204 * else return the group name.
5205 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5206 * make the link yourself if you need custom text
5208 * @param string $group Internal name of the group
5209 * @param string $text The text of the link
5210 * @return string Wikilink to the group
5212 public static function makeGroupLinkWiki( $group, $text = '' ) {
5213 wfDeprecated( __METHOD__
, '1.29' );
5215 if ( $text == '' ) {
5216 $text = UserGroupMembership
::getGroupName( $group );
5218 $title = UserGroupMembership
::getGroupPage( $group );
5220 $page = $title->getFullText();
5221 return "[[$page|$text]]";
5228 * Returns an array of the groups that a particular group can add/remove.
5230 * @param string $group The group to check for whether it can add/remove
5231 * @return array Array( 'add' => array( addablegroups ),
5232 * 'remove' => array( removablegroups ),
5233 * 'add-self' => array( addablegroups to self),
5234 * 'remove-self' => array( removable groups from self) )
5236 public static function changeableByGroup( $group ) {
5237 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
5246 if ( empty( $wgAddGroups[$group] ) ) {
5247 // Don't add anything to $groups
5248 } elseif ( $wgAddGroups[$group] === true ) {
5249 // You get everything
5250 $groups['add'] = self
::getAllGroups();
5251 } elseif ( is_array( $wgAddGroups[$group] ) ) {
5252 $groups['add'] = $wgAddGroups[$group];
5255 // Same thing for remove
5256 if ( empty( $wgRemoveGroups[$group] ) ) {
5258 } elseif ( $wgRemoveGroups[$group] === true ) {
5259 $groups['remove'] = self
::getAllGroups();
5260 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
5261 $groups['remove'] = $wgRemoveGroups[$group];
5264 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
5265 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
5266 foreach ( $wgGroupsAddToSelf as $key => $value ) {
5267 if ( is_int( $key ) ) {
5268 $wgGroupsAddToSelf['user'][] = $value;
5273 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
5274 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
5275 if ( is_int( $key ) ) {
5276 $wgGroupsRemoveFromSelf['user'][] = $value;
5281 // Now figure out what groups the user can add to him/herself
5282 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
5284 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
5285 // No idea WHY this would be used, but it's there
5286 $groups['add-self'] = self
::getAllGroups();
5287 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
5288 $groups['add-self'] = $wgGroupsAddToSelf[$group];
5291 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
5293 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
5294 $groups['remove-self'] = self
::getAllGroups();
5295 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
5296 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
5303 * Returns an array of groups that this user can add and remove
5304 * @return array Array( 'add' => array( addablegroups ),
5305 * 'remove' => array( removablegroups ),
5306 * 'add-self' => array( addablegroups to self),
5307 * 'remove-self' => array( removable groups from self) )
5309 public function changeableGroups() {
5310 if ( $this->isAllowed( 'userrights' ) ) {
5311 // This group gives the right to modify everything (reverse-
5312 // compatibility with old "userrights lets you change
5314 // Using array_merge to make the groups reindexed
5315 $all = array_merge( self
::getAllGroups() );
5324 // Okay, it's not so simple, we will have to go through the arrays
5331 $addergroups = $this->getEffectiveGroups();
5333 foreach ( $addergroups as $addergroup ) {
5334 $groups = array_merge_recursive(
5335 $groups, $this->changeableByGroup( $addergroup )
5337 $groups['add'] = array_unique( $groups['add'] );
5338 $groups['remove'] = array_unique( $groups['remove'] );
5339 $groups['add-self'] = array_unique( $groups['add-self'] );
5340 $groups['remove-self'] = array_unique( $groups['remove-self'] );
5346 * Schedule a deferred update to update the user's edit count
5348 public function incEditCount() {
5349 if ( $this->isAnon() ) {
5353 DeferredUpdates
::addUpdate(
5354 new UserEditCountUpdate( $this, 1 ),
5355 DeferredUpdates
::POSTSEND
5360 * This method should not be called outside User/UserEditCountUpdate
5364 public function setEditCountInternal( $count ) {
5365 $this->mEditCount
= $count;
5369 * Initialize user_editcount from data out of the revision table
5371 * This method should not be called outside User/UserEditCountUpdate
5373 * @return int Number of edits
5375 public function initEditCountInternal() {
5376 // Pull from a replica DB to be less cruel to servers
5377 // Accuracy isn't the point anyway here
5378 $dbr = wfGetDB( DB_REPLICA
);
5379 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5380 $count = (int)$dbr->selectField(
5381 [ 'revision' ] +
$actorWhere['tables'],
5383 [ $actorWhere['conds'] ],
5386 $actorWhere['joins']
5389 $dbw = wfGetDB( DB_MASTER
);
5392 [ 'user_editcount' => $count ],
5394 'user_id' => $this->getId(),
5395 'user_editcount IS NULL OR user_editcount < ' . (int)$count
5404 * Get the description of a given right
5407 * @param string $right Right to query
5408 * @return string Localized description of the right
5410 public static function getRightDescription( $right ) {
5411 $key = "right-$right";
5412 $msg = wfMessage( $key );
5413 return $msg->isDisabled() ?
$right : $msg->text();
5417 * Get the name of a given grant
5420 * @param string $grant Grant to query
5421 * @return string Localized name of the grant
5423 public static function getGrantName( $grant ) {
5424 $key = "grant-$grant";
5425 $msg = wfMessage( $key );
5426 return $msg->isDisabled() ?
$grant : $msg->text();
5430 * Add a newuser log entry for this user.
5431 * Before 1.19 the return value was always true.
5433 * @deprecated since 1.27, AuthManager handles logging
5434 * @param string|bool $action Account creation type.
5435 * - String, one of the following values:
5436 * - 'create' for an anonymous user creating an account for himself.
5437 * This will force the action's performer to be the created user itself,
5438 * no matter the value of $wgUser
5439 * - 'create2' for a logged in user creating an account for someone else
5440 * - 'byemail' when the created user will receive its password by e-mail
5441 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5442 * - Boolean means whether the account was created by e-mail (deprecated):
5443 * - true will be converted to 'byemail'
5444 * - false will be converted to 'create' if this object is the same as
5445 * $wgUser and to 'create2' otherwise
5446 * @param string $reason User supplied reason
5449 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5450 return true; // disabled
5454 * Add an autocreate newuser log entry for this user
5455 * Used by things like CentralAuth and perhaps other authplugins.
5456 * Consider calling addNewUserLogEntry() directly instead.
5458 * @deprecated since 1.27, AuthManager handles logging
5461 public function addNewUserLogEntryAutoCreate() {
5462 $this->addNewUserLogEntry( 'autocreate' );
5468 * Load the user options either from cache, the database or an array
5470 * @param array|null $data Rows for the current user out of the user_properties table
5472 protected function loadOptions( $data = null ) {
5475 if ( $this->mOptionsLoaded
) {
5479 $this->mOptions
= self
::getDefaultOptions();
5481 if ( !$this->getId() ) {
5482 // For unlogged-in users, load language/variant options from request.
5483 // There's no need to do it for logged-in users: they can set preferences,
5484 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5485 // so don't override user's choice (especially when the user chooses site default).
5486 $variant = MediaWikiServices
::getInstance()->getContentLanguage()->getDefaultVariant();
5487 $this->mOptions
['variant'] = $variant;
5488 $this->mOptions
['language'] = $variant;
5489 $this->mOptionsLoaded
= true;
5493 // Maybe load from the object
5494 if ( !is_null( $this->mOptionOverrides
) ) {
5495 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5496 foreach ( $this->mOptionOverrides
as $key => $value ) {
5497 $this->mOptions
[$key] = $value;
5500 if ( !is_array( $data ) ) {
5501 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5502 // Load from database
5503 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5504 ?
wfGetDB( DB_MASTER
)
5505 : wfGetDB( DB_REPLICA
);
5507 $res = $dbr->select(
5509 [ 'up_property', 'up_value' ],
5510 [ 'up_user' => $this->getId() ],
5514 $this->mOptionOverrides
= [];
5516 foreach ( $res as $row ) {
5517 // Convert '0' to 0. PHP's boolean conversion considers them both
5518 // false, but e.g. JavaScript considers the former as true.
5519 // @todo: T54542 Somehow determine the desired type (string/int/bool)
5520 // and convert all values here.
5521 if ( $row->up_value
=== '0' ) {
5524 $data[$row->up_property
] = $row->up_value
;
5528 foreach ( $data as $property => $value ) {
5529 $this->mOptionOverrides
[$property] = $value;
5530 $this->mOptions
[$property] = $value;
5534 // Replace deprecated language codes
5535 $this->mOptions
['language'] = LanguageCode
::replaceDeprecatedCodes(
5536 $this->mOptions
['language']
5539 $this->mOptionsLoaded
= true;
5541 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5545 * Saves the non-default options for this user, as previously set e.g. via
5546 * setOption(), in the database's "user_properties" (preferences) table.
5547 * Usually used via saveSettings().
5549 protected function saveOptions() {
5550 $this->loadOptions();
5552 // Not using getOptions(), to keep hidden preferences in database
5553 $saveOptions = $this->mOptions
;
5555 // Allow hooks to abort, for instance to save to a global profile.
5556 // Reset options to default state before saving.
5557 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5561 $userId = $this->getId();
5563 $insert_rows = []; // all the new preference rows
5564 foreach ( $saveOptions as $key => $value ) {
5565 // Don't bother storing default values
5566 $defaultOption = self
::getDefaultOption( $key );
5567 if ( ( $defaultOption === null && $value !== false && $value !== null )
5568 ||
$value != $defaultOption
5571 'up_user' => $userId,
5572 'up_property' => $key,
5573 'up_value' => $value,
5578 $dbw = wfGetDB( DB_MASTER
);
5580 $res = $dbw->select( 'user_properties',
5581 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5583 // Find prior rows that need to be removed or updated. These rows will
5584 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5586 foreach ( $res as $row ) {
5587 if ( !isset( $saveOptions[$row->up_property
] )
5588 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5590 $keysDelete[] = $row->up_property
;
5594 if ( count( $keysDelete ) ) {
5595 // Do the DELETE by PRIMARY KEY for prior rows.
5596 // In the past a very large portion of calls to this function are for setting
5597 // 'rememberpassword' for new accounts (a preference that has since been removed).
5598 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5599 // caused gap locks on [max user ID,+infinity) which caused high contention since
5600 // updates would pile up on each other as they are for higher (newer) user IDs.
5601 // It might not be necessary these days, but it shouldn't hurt either.
5602 $dbw->delete( 'user_properties',
5603 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5605 // Insert the new preference rows
5606 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5610 * Return the list of user fields that should be selected to create
5611 * a new user object.
5612 * @deprecated since 1.31, use self::getQueryInfo() instead.
5615 public static function selectFields() {
5616 wfDeprecated( __METHOD__
, '1.31' );
5624 'user_email_authenticated',
5626 'user_email_token_expires',
5627 'user_registration',
5633 * Return the tables, fields, and join conditions to be selected to create
5634 * a new user object.
5636 * @return array With three keys:
5637 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
5638 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
5639 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
5641 public static function getQueryInfo() {
5642 global $wgActorTableSchemaMigrationStage;
5645 'tables' => [ 'user' ],
5653 'user_email_authenticated',
5655 'user_email_token_expires',
5656 'user_registration',
5662 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
5663 // but it does little harm and might be needed for write callers loading a User.
5664 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
5665 $ret['tables']['user_actor'] = 'actor';
5666 $ret['fields'][] = 'user_actor.actor_id';
5667 $ret['joins']['user_actor'] = [
5668 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) ?
'JOIN' : 'LEFT JOIN',
5669 [ 'user_actor.actor_user = user_id' ]
5677 * Factory function for fatal permission-denied errors
5680 * @param string $permission User right required
5683 static function newFatalPermissionDeniedStatus( $permission ) {
5687 foreach ( self
::getGroupsWithPermission( $permission ) as $group ) {
5688 $groups[] = UserGroupMembership
::getLink( $group, RequestContext
::getMain(), 'wiki' );
5692 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5695 return Status
::newFatal( 'badaccess-group0' );
5699 * Get a new instance of this user that was loaded from the master via a locking read
5701 * Use this instead of the main context User when updating that user. This avoids races
5702 * where that user was loaded from a replica DB or even the master but without proper locks.
5704 * @return User|null Returns null if the user was not found in the DB
5707 public function getInstanceForUpdate() {
5708 if ( !$this->getId() ) {
5709 return null; // anon
5712 $user = self
::newFromId( $this->getId() );
5713 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5721 * Checks if two user objects point to the same user.
5723 * @since 1.25 ; takes a UserIdentity instead of a User since 1.32
5724 * @param UserIdentity $user
5727 public function equals( UserIdentity
$user ) {
5728 // XXX it's not clear whether central ID providers are supposed to obey this
5729 return $this->getName() === $user->getName();