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).
1195 * @param string $password Desired password
1199 public function checkPasswordValidity( $password ) {
1200 global $wgPasswordPolicy;
1202 $upp = new UserPasswordPolicy(
1203 $wgPasswordPolicy['policies'],
1204 $wgPasswordPolicy['checks']
1207 $status = Status
::newGood( [] );
1208 $result = false; // init $result to false for the internal checks
1210 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1211 $status->error( $result );
1215 if ( $result === false ) {
1216 $status->merge( $upp->checkUserPassword( $this, $password ), true );
1220 if ( $result === true ) {
1224 $status->error( $result );
1225 return $status; // the isValidPassword hook set a string $result and returned true
1229 * Given unvalidated user input, return a canonical username, or false if
1230 * the username is invalid.
1231 * @param string $name User input
1232 * @param string|bool $validate Type of validation to use:
1233 * - false No validation
1234 * - 'valid' Valid for batch processes
1235 * - 'usable' Valid for batch processes and login
1236 * - 'creatable' Valid for batch processes, login and account creation
1238 * @throws InvalidArgumentException
1239 * @return bool|string
1241 public static function getCanonicalName( $name, $validate = 'valid' ) {
1242 // Force usernames to capital
1243 $name = MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name );
1245 # Reject names containing '#'; these will be cleaned up
1246 # with title normalisation, but then it's too late to
1248 if ( strpos( $name, '#' ) !== false ) {
1252 // Clean up name according to title rules,
1253 // but only when validation is requested (T14654)
1254 $t = ( $validate !== false ) ?
1255 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1256 // Check for invalid titles
1257 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1261 $name = $t->getText();
1263 switch ( $validate ) {
1267 if ( !self
::isValidUserName( $name ) ) {
1272 if ( !self
::isUsableName( $name ) ) {
1277 if ( !self
::isCreatableName( $name ) ) {
1282 throw new InvalidArgumentException(
1283 'Invalid parameter value for $validate in ' . __METHOD__
);
1289 * Return a random password.
1291 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1292 * @return string New random password
1294 public static function randomPassword() {
1295 global $wgMinimalPasswordLength;
1296 return PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1300 * Set cached properties to default.
1302 * @note This no longer clears uncached lazy-initialised properties;
1303 * the constructor does that instead.
1305 * @param string|bool $name
1307 public function loadDefaults( $name = false ) {
1309 $this->mName
= $name;
1310 $this->mActorId
= null;
1311 $this->mRealName
= '';
1313 $this->mOptionOverrides
= null;
1314 $this->mOptionsLoaded
= false;
1316 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1317 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1318 if ( $loggedOut !== 0 ) {
1319 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1321 $this->mTouched
= '1'; # Allow any pages to be cached
1324 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1325 $this->mEmailAuthenticated
= null;
1326 $this->mEmailToken
= '';
1327 $this->mEmailTokenExpires
= null;
1328 $this->mRegistration
= wfTimestamp( TS_MW
);
1329 $this->mGroupMemberships
= [];
1331 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1335 * Return whether an item has been loaded.
1337 * @param string $item Item to check. Current possibilities:
1341 * @param string $all 'all' to check if the whole object has been loaded
1342 * or any other string to check if only the item is available (e.g.
1346 public function isItemLoaded( $item, $all = 'all' ) {
1347 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1348 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1352 * Set that an item has been loaded
1354 * @param string $item
1356 protected function setItemLoaded( $item ) {
1357 if ( is_array( $this->mLoadedItems
) ) {
1358 $this->mLoadedItems
[$item] = true;
1363 * Load user data from the session.
1365 * @return bool True if the user is logged in, false otherwise.
1367 private function loadFromSession() {
1370 Hooks
::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1371 if ( $result !== null ) {
1375 // MediaWiki\Session\Session already did the necessary authentication of the user
1376 // returned here, so just use it if applicable.
1377 $session = $this->getRequest()->getSession();
1378 $user = $session->getUser();
1379 if ( $user->isLoggedIn() ) {
1380 $this->loadFromUserObject( $user );
1381 if ( $user->isBlocked() ) {
1382 // If this user is autoblocked, set a cookie to track the Block. This has to be done on
1383 // every session load, because an autoblocked editor might not edit again from the same
1384 // IP address after being blocked.
1385 $this->trackBlockWithCookie();
1388 // Other code expects these to be set in the session, so set them.
1389 $session->set( 'wsUserID', $this->getId() );
1390 $session->set( 'wsUserName', $this->getName() );
1391 $session->set( 'wsToken', $this->getToken() );
1400 * Set the 'BlockID' cookie depending on block type and user authentication status.
1402 public function trackBlockWithCookie() {
1403 $block = $this->getBlock();
1404 if ( $block && $this->getRequest()->getCookie( 'BlockID' ) === null ) {
1405 $config = RequestContext
::getMain()->getConfig();
1406 $shouldSetCookie = false;
1408 if ( $this->isAnon() && $config->get( 'CookieSetOnIpBlock' ) ) {
1409 // If user is logged-out, set a cookie to track the Block
1410 $shouldSetCookie = in_array( $block->getType(), [
1411 Block
::TYPE_IP
, Block
::TYPE_RANGE
1413 if ( $shouldSetCookie ) {
1414 $block->setCookie( $this->getRequest()->response() );
1416 // temporary measure the use of cookies on ip blocks
1417 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1418 $stats->increment( 'block.ipblock.setCookie.success' );
1420 } elseif ( $this->isLoggedIn() && $config->get( 'CookieSetOnAutoblock' ) ) {
1421 $shouldSetCookie = $block->getType() === Block
::TYPE_USER
&& $block->isAutoblocking();
1422 if ( $shouldSetCookie ) {
1423 $block->setCookie( $this->getRequest()->response() );
1430 * Load user and user_group data from the database.
1431 * $this->mId must be set, this is how the user is identified.
1433 * @param int $flags User::READ_* constant bitfield
1434 * @return bool True if the user exists, false if the user is anonymous
1436 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1438 $this->mId
= intval( $this->mId
);
1440 if ( !$this->mId
) {
1441 // Anonymous users are not in the database
1442 $this->loadDefaults();
1446 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1447 $db = wfGetDB( $index );
1449 $userQuery = self
::getQueryInfo();
1450 $s = $db->selectRow(
1451 $userQuery['tables'],
1452 $userQuery['fields'],
1453 [ 'user_id' => $this->mId
],
1459 $this->queryFlagsUsed
= $flags;
1460 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1462 if ( $s !== false ) {
1463 // Initialise user table data
1464 $this->loadFromRow( $s );
1465 $this->mGroupMemberships
= null; // deferred
1466 $this->getEditCount(); // revalidation for nulls
1472 $this->loadDefaults();
1478 * Initialize this object from a row from the user table.
1480 * @param stdClass $row Row from the user table to load.
1481 * @param array|null $data Further user data to load into the object
1483 * user_groups Array of arrays or stdClass result rows out of the user_groups
1484 * table. Previously you were supposed to pass an array of strings
1485 * here, but we also need expiry info nowadays, so an array of
1486 * strings is ignored.
1487 * user_properties Array with properties out of the user_properties table
1489 protected function loadFromRow( $row, $data = null ) {
1490 global $wgActorTableSchemaMigrationStage;
1492 if ( !is_object( $row ) ) {
1493 throw new InvalidArgumentException( '$row must be an object' );
1498 $this->mGroupMemberships
= null; // deferred
1500 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
1501 // but it does little harm and might be needed for write callers loading a User.
1502 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
1503 if ( isset( $row->actor_id
) ) {
1504 $this->mActorId
= (int)$row->actor_id
;
1505 if ( $this->mActorId
!== 0 ) {
1506 $this->mFrom
= 'actor';
1508 $this->setItemLoaded( 'actor' );
1514 if ( isset( $row->user_name
) && $row->user_name
!== '' ) {
1515 $this->mName
= $row->user_name
;
1516 $this->mFrom
= 'name';
1517 $this->setItemLoaded( 'name' );
1522 if ( isset( $row->user_real_name
) ) {
1523 $this->mRealName
= $row->user_real_name
;
1524 $this->setItemLoaded( 'realname' );
1529 if ( isset( $row->user_id
) ) {
1530 $this->mId
= intval( $row->user_id
);
1531 if ( $this->mId
!== 0 ) {
1532 $this->mFrom
= 'id';
1534 $this->setItemLoaded( 'id' );
1539 if ( isset( $row->user_id
) && isset( $row->user_name
) && $row->user_name
!== '' ) {
1540 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1543 if ( isset( $row->user_editcount
) ) {
1544 $this->mEditCount
= $row->user_editcount
;
1549 if ( isset( $row->user_touched
) ) {
1550 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1555 if ( isset( $row->user_token
) ) {
1556 // The definition for the column is binary(32), so trim the NULs
1557 // that appends. The previous definition was char(32), so trim
1559 $this->mToken
= rtrim( $row->user_token
, " \0" );
1560 if ( $this->mToken
=== '' ) {
1561 $this->mToken
= null;
1567 if ( isset( $row->user_email
) ) {
1568 $this->mEmail
= $row->user_email
;
1569 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1570 $this->mEmailToken
= $row->user_email_token
;
1571 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1572 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1578 $this->mLoadedItems
= true;
1581 if ( is_array( $data ) ) {
1582 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1583 if ( $data['user_groups'] === [] ) {
1584 $this->mGroupMemberships
= [];
1586 $firstGroup = reset( $data['user_groups'] );
1587 if ( is_array( $firstGroup ) ||
is_object( $firstGroup ) ) {
1588 $this->mGroupMemberships
= [];
1589 foreach ( $data['user_groups'] as $row ) {
1590 $ugm = UserGroupMembership
::newFromRow( (object)$row );
1591 $this->mGroupMemberships
[$ugm->getGroup()] = $ugm;
1596 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1597 $this->loadOptions( $data['user_properties'] );
1603 * Load the data for this user object from another user object.
1607 protected function loadFromUserObject( $user ) {
1609 foreach ( self
::$mCacheVars as $var ) {
1610 $this->$var = $user->$var;
1615 * Load the groups from the database if they aren't already loaded.
1617 private function loadGroups() {
1618 if ( is_null( $this->mGroupMemberships
) ) {
1619 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1620 ?
wfGetDB( DB_MASTER
)
1621 : wfGetDB( DB_REPLICA
);
1622 $this->mGroupMemberships
= UserGroupMembership
::getMembershipsForUser(
1628 * Add the user to the group if he/she meets given criteria.
1630 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1631 * possible to remove manually via Special:UserRights. In such case it
1632 * will not be re-added automatically. The user will also not lose the
1633 * group if they no longer meet the criteria.
1635 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1637 * @return array Array of groups the user has been promoted to.
1639 * @see $wgAutopromoteOnce
1641 public function addAutopromoteOnceGroups( $event ) {
1642 global $wgAutopromoteOnceLogInRC;
1644 if ( wfReadOnly() ||
!$this->getId() ) {
1648 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1649 if ( $toPromote === [] ) {
1653 if ( !$this->checkAndSetTouched() ) {
1654 return []; // raced out (bug T48834)
1657 $oldGroups = $this->getGroups(); // previous groups
1658 $oldUGMs = $this->getGroupMemberships();
1659 foreach ( $toPromote as $group ) {
1660 $this->addGroup( $group );
1662 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1663 $newUGMs = $this->getGroupMemberships();
1665 // update groups in external authentication database
1666 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );
1668 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1669 $logEntry->setPerformer( $this );
1670 $logEntry->setTarget( $this->getUserPage() );
1671 $logEntry->setParameters( [
1672 '4::oldgroups' => $oldGroups,
1673 '5::newgroups' => $newGroups,
1675 $logid = $logEntry->insert();
1676 if ( $wgAutopromoteOnceLogInRC ) {
1677 $logEntry->publish( $logid );
1684 * Builds update conditions. Additional conditions may be added to $conditions to
1685 * protected against race conditions using a compare-and-set (CAS) mechanism
1686 * based on comparing $this->mTouched with the user_touched field.
1688 * @param Database $db
1689 * @param array $conditions WHERE conditions for use with Database::update
1690 * @return array WHERE conditions for use with Database::update
1692 protected function makeUpdateConditions( Database
$db, array $conditions ) {
1693 if ( $this->mTouched
) {
1694 // CAS check: only update if the row wasn't changed sicne it was loaded.
1695 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1702 * Bump user_touched if it didn't change since this object was loaded
1704 * On success, the mTouched field is updated.
1705 * The user serialization cache is always cleared.
1707 * @return bool Whether user_touched was actually updated
1710 protected function checkAndSetTouched() {
1713 if ( !$this->mId
) {
1714 return false; // anon
1717 // Get a new user_touched that is higher than the old one
1718 $newTouched = $this->newTouchedTimestamp();
1720 $dbw = wfGetDB( DB_MASTER
);
1721 $dbw->update( 'user',
1722 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1723 $this->makeUpdateConditions( $dbw, [
1724 'user_id' => $this->mId
,
1728 $success = ( $dbw->affectedRows() > 0 );
1731 $this->mTouched
= $newTouched;
1732 $this->clearSharedCache();
1734 // Clears on failure too since that is desired if the cache is stale
1735 $this->clearSharedCache( 'refresh' );
1742 * Clear various cached data stored in this object. The cache of the user table
1743 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1745 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1746 * given source. May be "name", "id", "actor", "defaults", "session", or false for no reload.
1748 public function clearInstanceCache( $reloadFrom = false ) {
1749 $this->mNewtalk
= -1;
1750 $this->mDatePreference
= null;
1751 $this->mBlockedby
= -1; # Unset
1752 $this->mHash
= false;
1753 $this->mRights
= null;
1754 $this->mEffectiveGroups
= null;
1755 $this->mImplicitGroups
= null;
1756 $this->mGroupMemberships
= null;
1757 $this->mOptions
= null;
1758 $this->mOptionsLoaded
= false;
1759 $this->mEditCount
= null;
1761 if ( $reloadFrom ) {
1762 $this->mLoadedItems
= [];
1763 $this->mFrom
= $reloadFrom;
1768 * Combine the language default options with any site-specific options
1769 * and add the default language variants.
1771 * @return array Array of String options
1773 public static function getDefaultOptions() {
1774 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgDefaultSkin;
1776 static $defOpt = null;
1777 static $defOptLang = null;
1779 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
1780 if ( $defOpt !== null && $defOptLang === $contLang->getCode() ) {
1781 // The content language does not change (and should not change) mid-request, but the
1782 // unit tests change it anyway, and expect this method to return values relevant to the
1783 // current content language.
1787 $defOpt = $wgDefaultUserOptions;
1788 // Default language setting
1789 $defOptLang = $contLang->getCode();
1790 $defOpt['language'] = $defOptLang;
1791 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1792 if ( $langCode === $contLang->getCode() ) {
1793 $defOpt['variant'] = $langCode;
1795 $defOpt["variant-$langCode"] = $langCode;
1799 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1800 // since extensions may change the set of searchable namespaces depending
1801 // on user groups/permissions.
1802 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1803 $defOpt['searchNs' . $nsnum] = (bool)$val;
1805 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1807 Hooks
::run( 'UserGetDefaultOptions', [ &$defOpt ] );
1813 * Get a given default option value.
1815 * @param string $opt Name of option to retrieve
1816 * @return string Default option value
1818 public static function getDefaultOption( $opt ) {
1819 $defOpts = self
::getDefaultOptions();
1820 return $defOpts[$opt] ??
null;
1824 * Get blocking information
1825 * @param bool $bFromReplica Whether to check the replica DB first.
1826 * To improve performance, non-critical checks are done against replica DBs.
1827 * Check when actually saving should be done against master.
1829 private function getBlockedStatus( $bFromReplica = true ) {
1830 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff, $wgSoftBlockRanges;
1832 if ( $this->mBlockedby
!= -1 ) {
1836 wfDebug( __METHOD__
. ": checking...\n" );
1838 // Initialize data...
1839 // Otherwise something ends up stomping on $this->mBlockedby when
1840 // things get lazy-loaded later, causing false positive block hits
1841 // due to -1 !== 0. Probably session-related... Nothing should be
1842 // overwriting mBlockedby, surely?
1845 # We only need to worry about passing the IP address to the Block generator if the
1846 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1847 # know which IP address they're actually coming from
1849 if ( !$this->isAllowed( 'ipblock-exempt' ) ) {
1850 // $wgUser->getName() only works after the end of Setup.php. Until
1851 // then, assume it's a logged-out user.
1852 $globalUserName = $wgUser->isSafeToLoad()
1853 ?
$wgUser->getName()
1854 : IP
::sanitizeIP( $wgUser->getRequest()->getIP() );
1855 if ( $this->getName() === $globalUserName ) {
1856 $ip = $this->getRequest()->getIP();
1861 $block = Block
::newFromTarget( $this, $ip, !$bFromReplica );
1864 if ( !$block instanceof Block
) {
1865 $block = $this->getBlockFromCookieValue( $this->getRequest()->getCookie( 'BlockID' ) );
1869 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1871 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1872 $block = new Block( [
1873 'byText' => wfMessage( 'proxyblocker' )->text(),
1874 'reason' => wfMessage( 'proxyblockreason' )->plain(),
1876 'systemBlock' => 'proxy',
1878 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1879 $block = new Block( [
1880 'byText' => wfMessage( 'sorbs' )->text(),
1881 'reason' => wfMessage( 'sorbsreason' )->plain(),
1883 'systemBlock' => 'dnsbl',
1888 // (T25343) Apply IP blocks to the contents of XFF headers, if enabled
1889 if ( !$block instanceof Block
1890 && $wgApplyIpBlocksToXff
1892 && !in_array( $ip, $wgProxyWhitelist )
1894 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1895 $xff = array_map( 'trim', explode( ',', $xff ) );
1896 $xff = array_diff( $xff, [ $ip ] );
1897 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromReplica );
1898 $block = Block
::chooseBlock( $xffblocks, $xff );
1899 if ( $block instanceof Block
) {
1900 # Mangle the reason to alert the user that the block
1901 # originated from matching the X-Forwarded-For header.
1902 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->plain();
1906 if ( !$block instanceof Block
1909 && IP
::isInRanges( $ip, $wgSoftBlockRanges )
1911 $block = new Block( [
1913 'byText' => 'MediaWiki default',
1914 'reason' => wfMessage( 'softblockrangesreason', $ip )->plain(),
1916 'systemBlock' => 'wgSoftBlockRanges',
1920 if ( $block instanceof Block
) {
1921 wfDebug( __METHOD__
. ": Found block.\n" );
1922 $this->mBlock
= $block;
1923 $this->mBlockedby
= $block->getByName();
1924 $this->mBlockreason
= $block->mReason
;
1925 $this->mHideName
= $block->mHideName
;
1926 $this->mAllowUsertalk
= $block->isUsertalkEditAllowed();
1928 $this->mBlock
= null;
1929 $this->mBlockedby
= '';
1930 $this->mBlockreason
= '';
1931 $this->mHideName
= 0;
1932 $this->mAllowUsertalk
= false;
1935 // Avoid PHP 7.1 warning of passing $this by reference
1938 Hooks
::run( 'GetBlockedStatus', [ &$user ] );
1942 * Try to load a Block from an ID given in a cookie value.
1943 * @param string|null $blockCookieVal The cookie value to check.
1944 * @return Block|bool The Block object, or false if none could be loaded.
1946 protected function getBlockFromCookieValue( $blockCookieVal ) {
1947 // Make sure there's something to check. The cookie value must start with a number.
1948 if ( strlen( $blockCookieVal ) < 1 ||
!is_numeric( substr( $blockCookieVal, 0, 1 ) ) ) {
1951 // Load the Block from the ID in the cookie.
1952 $blockCookieId = Block
::getIdFromCookieValue( $blockCookieVal );
1953 if ( $blockCookieId !== null ) {
1954 // An ID was found in the cookie.
1955 $tmpBlock = Block
::newFromID( $blockCookieId );
1956 if ( $tmpBlock instanceof Block
) {
1957 $config = RequestContext
::getMain()->getConfig();
1959 switch ( $tmpBlock->getType() ) {
1960 case Block
::TYPE_USER
:
1961 $blockIsValid = !$tmpBlock->isExpired() && $tmpBlock->isAutoblocking();
1962 $useBlockCookie = ( $config->get( 'CookieSetOnAutoblock' ) === true );
1964 case Block
::TYPE_IP
:
1965 case Block
::TYPE_RANGE
:
1966 // If block is type IP or IP range, load only if user is not logged in (T152462)
1967 $blockIsValid = !$tmpBlock->isExpired() && !$this->isLoggedIn();
1968 $useBlockCookie = ( $config->get( 'CookieSetOnIpBlock' ) === true );
1971 $blockIsValid = false;
1972 $useBlockCookie = false;
1975 if ( $blockIsValid && $useBlockCookie ) {
1980 // If the block is not valid, remove the cookie.
1981 Block
::clearCookie( $this->getRequest()->response() );
1983 // If the block doesn't exist, remove the cookie.
1984 Block
::clearCookie( $this->getRequest()->response() );
1991 * Whether the given IP is in a DNS blacklist.
1993 * @param string $ip IP to check
1994 * @param bool $checkWhitelist Whether to check the whitelist first
1995 * @return bool True if blacklisted.
1997 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1998 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
2000 if ( !$wgEnableDnsBlacklist ||
2001 ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
2006 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
2010 * Whether the given IP is in a given DNS blacklist.
2012 * @param string $ip IP to check
2013 * @param string|array $bases Array of Strings: URL of the DNS blacklist
2014 * @return bool True if blacklisted.
2016 public function inDnsBlacklist( $ip, $bases ) {
2018 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
2019 if ( IP
::isIPv4( $ip ) ) {
2020 // Reverse IP, T23255
2021 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
2023 foreach ( (array)$bases as $base ) {
2025 // If we have an access key, use that too (ProjectHoneypot, etc.)
2027 if ( is_array( $base ) ) {
2028 if ( count( $base ) >= 2 ) {
2029 // Access key is 1, base URL is 0
2030 $host = "{$base[1]}.$ipReversed.{$base[0]}";
2032 $host = "$ipReversed.{$base[0]}";
2034 $basename = $base[0];
2036 $host = "$ipReversed.$base";
2040 $ipList = gethostbynamel( $host );
2043 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
2048 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
2056 * Check if an IP address is in the local proxy list
2062 public static function isLocallyBlockedProxy( $ip ) {
2063 global $wgProxyList;
2065 if ( !$wgProxyList ) {
2069 if ( !is_array( $wgProxyList ) ) {
2070 // Load values from the specified file
2071 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
2074 $resultProxyList = [];
2075 $deprecatedIPEntries = [];
2077 // backward compatibility: move all ip addresses in keys to values
2078 foreach ( $wgProxyList as $key => $value ) {
2079 $keyIsIP = IP
::isIPAddress( $key );
2080 $valueIsIP = IP
::isIPAddress( $value );
2081 if ( $keyIsIP && !$valueIsIP ) {
2082 $deprecatedIPEntries[] = $key;
2083 $resultProxyList[] = $key;
2084 } elseif ( $keyIsIP && $valueIsIP ) {
2085 $deprecatedIPEntries[] = $key;
2086 $resultProxyList[] = $key;
2087 $resultProxyList[] = $value;
2089 $resultProxyList[] = $value;
2093 if ( $deprecatedIPEntries ) {
2095 'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
2096 implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
2099 $proxyListIPSet = new IPSet( $resultProxyList );
2100 return $proxyListIPSet->match( $ip );
2104 * Is this user subject to rate limiting?
2106 * @return bool True if rate limited
2108 public function isPingLimitable() {
2109 global $wgRateLimitsExcludedIPs;
2110 if ( IP
::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
2111 // No other good way currently to disable rate limits
2112 // for specific IPs. :P
2113 // But this is a crappy hack and should die.
2116 return !$this->isAllowed( 'noratelimit' );
2120 * Primitive rate limits: enforce maximum actions per time period
2121 * to put a brake on flooding.
2123 * The method generates both a generic profiling point and a per action one
2124 * (suffix being "-$action".
2126 * @note When using a shared cache like memcached, IP-address
2127 * last-hit counters will be shared across wikis.
2129 * @param string $action Action to enforce; 'edit' if unspecified
2130 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
2131 * @return bool True if a rate limiter was tripped
2133 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
2134 // Avoid PHP 7.1 warning of passing $this by reference
2136 // Call the 'PingLimiter' hook
2138 if ( !Hooks
::run( 'PingLimiter', [ &$user, $action, &$result, $incrBy ] ) ) {
2142 global $wgRateLimits;
2143 if ( !isset( $wgRateLimits[$action] ) ) {
2147 $limits = array_merge(
2148 [ '&can-bypass' => true ],
2149 $wgRateLimits[$action]
2152 // Some groups shouldn't trigger the ping limiter, ever
2153 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
2158 $id = $this->getId();
2160 $isNewbie = $this->isNewbie();
2161 $cache = ObjectCache
::getLocalClusterInstance();
2165 if ( isset( $limits['anon'] ) ) {
2166 $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
2168 } elseif ( isset( $limits['user'] ) ) {
2169 // limits for logged-in users
2170 $userLimit = $limits['user'];
2173 // limits for anons and for newbie logged-in users
2176 if ( isset( $limits['ip'] ) ) {
2177 $ip = $this->getRequest()->getIP();
2178 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
2180 // subnet-based limits
2181 if ( isset( $limits['subnet'] ) ) {
2182 $ip = $this->getRequest()->getIP();
2183 $subnet = IP
::getSubnet( $ip );
2184 if ( $subnet !== false ) {
2185 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
2190 // Check for group-specific permissions
2191 // If more than one group applies, use the group with the highest limit ratio (max/period)
2192 foreach ( $this->getGroups() as $group ) {
2193 if ( isset( $limits[$group] ) ) {
2194 if ( $userLimit === false
2195 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
2197 $userLimit = $limits[$group];
2202 // limits for newbie logged-in users (override all the normal user limits)
2203 if ( $id !== 0 && $isNewbie && isset( $limits['newbie'] ) ) {
2204 $userLimit = $limits['newbie'];
2207 // Set the user limit key
2208 if ( $userLimit !== false ) {
2209 list( $max, $period ) = $userLimit;
2210 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
2211 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
2214 // ip-based limits for all ping-limitable users
2215 if ( isset( $limits['ip-all'] ) ) {
2216 $ip = $this->getRequest()->getIP();
2217 // ignore if user limit is more permissive
2218 if ( $isNewbie ||
$userLimit === false
2219 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
2220 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
2224 // subnet-based limits for all ping-limitable users
2225 if ( isset( $limits['subnet-all'] ) ) {
2226 $ip = $this->getRequest()->getIP();
2227 $subnet = IP
::getSubnet( $ip );
2228 if ( $subnet !== false ) {
2229 // ignore if user limit is more permissive
2230 if ( $isNewbie ||
$userLimit === false
2231 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
2232 > $userLimit[0] / $userLimit[1] ) {
2233 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
2239 foreach ( $keys as $key => $limit ) {
2240 list( $max, $period ) = $limit;
2241 $summary = "(limit $max in {$period}s)";
2242 $count = $cache->get( $key );
2245 if ( $count >= $max ) {
2246 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
2247 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
2250 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
2253 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
2254 if ( $incrBy > 0 ) {
2255 $cache->add( $key, 0, intval( $period ) ); // first ping
2258 if ( $incrBy > 0 ) {
2259 $cache->incr( $key, $incrBy );
2267 * Check if user is blocked
2269 * @param bool $bFromReplica Whether to check the replica DB instead of
2270 * the master. Hacked from false due to horrible probs on site.
2271 * @return bool True if blocked, false otherwise
2273 public function isBlocked( $bFromReplica = true ) {
2274 return $this->getBlock( $bFromReplica ) instanceof Block
&&
2275 $this->getBlock()->appliesToRight( 'edit' );
2279 * Get the block affecting the user, or null if the user is not blocked
2281 * @param bool $bFromReplica Whether to check the replica DB instead of the master
2282 * @return Block|null
2284 public function getBlock( $bFromReplica = true ) {
2285 $this->getBlockedStatus( $bFromReplica );
2286 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
2290 * Check if user is blocked from editing a particular article
2292 * @param Title $title Title to check
2293 * @param bool $fromReplica Whether to check the replica DB instead of the master
2296 public function isBlockedFrom( $title, $fromReplica = false ) {
2297 $blocked = $this->isHidden();
2300 $block = $this->getBlock( $fromReplica );
2302 // Special handling for a user's own talk page. The block is not aware
2303 // of the user, so this must be done here.
2304 if ( $title->equals( $this->getTalkPage() ) ) {
2305 $blocked = $block->appliesToUsertalk( $title );
2307 $blocked = $block->appliesToTitle( $title );
2312 // only for the purpose of the hook. We really don't need this here.
2313 $allowUsertalk = $this->mAllowUsertalk
;
2315 Hooks
::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
2321 * If user is blocked, return the name of the user who placed the block
2322 * @return string Name of blocker
2324 public function blockedBy() {
2325 $this->getBlockedStatus();
2326 return $this->mBlockedby
;
2330 * If user is blocked, return the specified reason for the block
2331 * @return string Blocking reason
2333 public function blockedFor() {
2334 $this->getBlockedStatus();
2335 return $this->mBlockreason
;
2339 * If user is blocked, return the ID for the block
2340 * @return int Block ID
2342 public function getBlockId() {
2343 $this->getBlockedStatus();
2344 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2348 * Check if user is blocked on all wikis.
2349 * Do not use for actual edit permission checks!
2350 * This is intended for quick UI checks.
2352 * @param string $ip IP address, uses current client if none given
2353 * @return bool True if blocked, false otherwise
2355 public function isBlockedGlobally( $ip = '' ) {
2356 return $this->getGlobalBlock( $ip ) instanceof Block
;
2360 * Check if user is blocked on all wikis.
2361 * Do not use for actual edit permission checks!
2362 * This is intended for quick UI checks.
2364 * @param string $ip IP address, uses current client if none given
2365 * @return Block|null Block object if blocked, null otherwise
2366 * @throws FatalError
2367 * @throws MWException
2369 public function getGlobalBlock( $ip = '' ) {
2370 if ( $this->mGlobalBlock
!== null ) {
2371 return $this->mGlobalBlock ?
: null;
2373 // User is already an IP?
2374 if ( IP
::isIPAddress( $this->getName() ) ) {
2375 $ip = $this->getName();
2377 $ip = $this->getRequest()->getIP();
2379 // Avoid PHP 7.1 warning of passing $this by reference
2383 Hooks
::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
2385 if ( $blocked && $block === null ) {
2386 // back-compat: UserIsBlockedGlobally didn't have $block param first
2387 $block = new Block( [
2389 'systemBlock' => 'global-block'
2393 $this->mGlobalBlock
= $blocked ?
$block : false;
2394 return $this->mGlobalBlock ?
: null;
2398 * Check if user account is locked
2400 * @return bool True if locked, false otherwise
2402 public function isLocked() {
2403 if ( $this->mLocked
!== null ) {
2404 return $this->mLocked
;
2407 $this->mLocked
= false;
2408 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2409 return $this->mLocked
;
2413 * Check if user account is hidden
2415 * @return bool True if hidden, false otherwise
2417 public function isHidden() {
2418 if ( $this->mHideName
!== null ) {
2419 return (bool)$this->mHideName
;
2421 $this->getBlockedStatus();
2422 if ( !$this->mHideName
) {
2424 $this->mHideName
= false;
2425 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2427 return (bool)$this->mHideName
;
2431 * Get the user's ID.
2432 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2434 public function getId() {
2435 if ( $this->mId
=== null && $this->mName
!== null && self
::isIP( $this->mName
) ) {
2436 // Special case, we know the user is anonymous
2440 if ( !$this->isItemLoaded( 'id' ) ) {
2441 // Don't load if this was initialized from an ID
2445 return (int)$this->mId
;
2449 * Set the user and reload all fields according to a given ID
2450 * @param int $v User ID to reload
2452 public function setId( $v ) {
2454 $this->clearInstanceCache( 'id' );
2458 * Get the user name, or the IP of an anonymous user
2459 * @return string User's name or IP address
2461 public function getName() {
2462 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2463 // Special case optimisation
2464 return $this->mName
;
2468 if ( $this->mName
=== false ) {
2470 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2473 return $this->mName
;
2477 * Set the user name.
2479 * This does not reload fields from the database according to the given
2480 * name. Rather, it is used to create a temporary "nonexistent user" for
2481 * later addition to the database. It can also be used to set the IP
2482 * address for an anonymous user to something other than the current
2485 * @note User::newFromName() has roughly the same function, when the named user
2487 * @param string $str New user name to set
2489 public function setName( $str ) {
2491 $this->mName
= $str;
2495 * Get the user's actor ID.
2497 * @param IDatabase|null $dbw Assign a new actor ID, using this DB handle, if none exists
2498 * @return int The actor's ID, or 0 if no actor ID exists and $dbw was null
2500 public function getActorId( IDatabase
$dbw = null ) {
2501 global $wgActorTableSchemaMigrationStage;
2503 // Technically we should always return 0 without SCHEMA_COMPAT_READ_NEW,
2504 // but it does little harm and might be needed for write callers loading a User.
2505 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) ) {
2509 if ( !$this->isItemLoaded( 'actor' ) ) {
2513 // Currently $this->mActorId might be null if $this was loaded from a
2514 // cache entry that was written when $wgActorTableSchemaMigrationStage
2515 // was SCHEMA_COMPAT_OLD. Once that is no longer a possibility (i.e. when
2516 // User::VERSION is incremented after $wgActorTableSchemaMigrationStage
2517 // has been removed), that condition may be removed.
2518 if ( $this->mActorId
=== null ||
!$this->mActorId
&& $dbw ) {
2520 'actor_user' => $this->getId() ?
: null,
2521 'actor_name' => (string)$this->getName(),
2524 if ( $q['actor_user'] === null && self
::isUsableName( $q['actor_name'] ) ) {
2525 throw new CannotCreateActorException(
2526 'Cannot create an actor for a usable name that is not an existing user'
2529 if ( $q['actor_name'] === '' ) {
2530 throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
2532 $dbw->insert( 'actor', $q, __METHOD__
, [ 'IGNORE' ] );
2533 if ( $dbw->affectedRows() ) {
2534 $this->mActorId
= (int)$dbw->insertId();
2537 // Use LOCK IN SHARE MODE to bypass any MySQL REPEATABLE-READ snapshot.
2538 $this->mActorId
= (int)$dbw->selectField(
2543 [ 'LOCK IN SHARE MODE' ]
2545 if ( !$this->mActorId
) {
2546 throw new CannotCreateActorException(
2547 "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
2551 $this->invalidateCache();
2553 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2554 $db = wfGetDB( $index );
2555 $this->mActorId
= (int)$db->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2557 $this->setItemLoaded( 'actor' );
2560 return (int)$this->mActorId
;
2564 * Get the user's name escaped by underscores.
2565 * @return string Username escaped by underscores.
2567 public function getTitleKey() {
2568 return str_replace( ' ', '_', $this->getName() );
2572 * Check if the user has new messages.
2573 * @return bool True if the user has new messages
2575 public function getNewtalk() {
2578 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2579 if ( $this->mNewtalk
=== -1 ) {
2580 $this->mNewtalk
= false; # reset talk page status
2582 // Check memcached separately for anons, who have no
2583 // entire User object stored in there.
2584 if ( !$this->mId
) {
2585 global $wgDisableAnonTalk;
2586 if ( $wgDisableAnonTalk ) {
2587 // Anon newtalk disabled by configuration.
2588 $this->mNewtalk
= false;
2590 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2593 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2597 return (bool)$this->mNewtalk
;
2601 * Return the data needed to construct links for new talk page message
2602 * alerts. If there are new messages, this will return an associative array
2603 * with the following data:
2604 * wiki: The database name of the wiki
2605 * link: Root-relative link to the user's talk page
2606 * rev: The last talk page revision that the user has seen or null. This
2607 * is useful for building diff links.
2608 * If there are no new messages, it returns an empty array.
2609 * @note This function was designed to accomodate multiple talk pages, but
2610 * currently only returns a single link and revision.
2613 public function getNewMessageLinks() {
2614 // Avoid PHP 7.1 warning of passing $this by reference
2617 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
2621 if ( !$this->getNewtalk() ) {
2624 $utp = $this->getTalkPage();
2625 $dbr = wfGetDB( DB_REPLICA
);
2626 // Get the "last viewed rev" timestamp from the oldest message notification
2627 $timestamp = $dbr->selectField( 'user_newtalk',
2628 'MIN(user_last_timestamp)',
2629 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2631 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2634 'wiki' => WikiMap
::getWikiIdFromDbDomain( WikiMap
::getCurrentWikiDbDomain() ),
2635 'link' => $utp->getLocalURL(),
2642 * Get the revision ID for the last talk page revision viewed by the talk
2644 * @return int|null Revision ID or null
2646 public function getNewMessageRevisionId() {
2647 $newMessageRevisionId = null;
2648 $newMessageLinks = $this->getNewMessageLinks();
2650 // Note: getNewMessageLinks() never returns more than a single link
2651 // and it is always for the same wiki, but we double-check here in
2652 // case that changes some time in the future.
2653 if ( $newMessageLinks && count( $newMessageLinks ) === 1
2654 && WikiMap
::isCurrentWikiId( $newMessageLinks[0]['wiki'] )
2655 && $newMessageLinks[0]['rev']
2657 /** @var Revision $newMessageRevision */
2658 $newMessageRevision = $newMessageLinks[0]['rev'];
2659 $newMessageRevisionId = $newMessageRevision->getId();
2662 return $newMessageRevisionId;
2666 * Internal uncached check for new messages
2669 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2670 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2671 * @return bool True if the user has new messages
2673 protected function checkNewtalk( $field, $id ) {
2674 $dbr = wfGetDB( DB_REPLICA
);
2676 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2678 return $ok !== false;
2682 * Add or update the new messages flag
2683 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2684 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2685 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2686 * @return bool True if successful, false otherwise
2688 protected function updateNewtalk( $field, $id, $curRev = null ) {
2689 // Get timestamp of the talk page revision prior to the current one
2690 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2691 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2692 // Mark the user as having new messages since this revision
2693 $dbw = wfGetDB( DB_MASTER
);
2694 $dbw->insert( 'user_newtalk',
2695 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2698 if ( $dbw->affectedRows() ) {
2699 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2703 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2708 * Clear the new messages flag for the given user
2709 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2710 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2711 * @return bool True if successful, false otherwise
2713 protected function deleteNewtalk( $field, $id ) {
2714 $dbw = wfGetDB( DB_MASTER
);
2715 $dbw->delete( 'user_newtalk',
2718 if ( $dbw->affectedRows() ) {
2719 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2723 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2728 * Update the 'You have new messages!' status.
2729 * @param bool $val Whether the user has new messages
2730 * @param Revision|null $curRev New, as yet unseen revision of the user talk
2731 * page. Ignored if null or !$val.
2733 public function setNewtalk( $val, $curRev = null ) {
2734 if ( wfReadOnly() ) {
2739 $this->mNewtalk
= $val;
2741 if ( $this->isAnon() ) {
2743 $id = $this->getName();
2746 $id = $this->getId();
2750 $changed = $this->updateNewtalk( $field, $id, $curRev );
2752 $changed = $this->deleteNewtalk( $field, $id );
2756 $this->invalidateCache();
2761 * Generate a current or new-future timestamp to be stored in the
2762 * user_touched field when we update things.
2763 * @return string Timestamp in TS_MW format
2765 private function newTouchedTimestamp() {
2766 global $wgClockSkewFudge;
2768 $time = wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2769 if ( $this->mTouched
&& $time <= $this->mTouched
) {
2770 $time = wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2777 * Clear user data from memcached
2779 * Use after applying updates to the database; caller's
2780 * responsibility to update user_touched if appropriate.
2782 * Called implicitly from invalidateCache() and saveSettings().
2784 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2786 public function clearSharedCache( $mode = 'changed' ) {
2787 if ( !$this->getId() ) {
2791 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2792 $key = $this->getCacheKey( $cache );
2793 if ( $mode === 'refresh' ) {
2794 $cache->delete( $key, 1 );
2796 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2797 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2798 $lb->getConnection( DB_MASTER
)->onTransactionPreCommitOrIdle(
2799 function () use ( $cache, $key ) {
2800 $cache->delete( $key );
2805 $cache->delete( $key );
2811 * Immediately touch the user data cache for this account
2813 * Calls touch() and removes account data from memcached
2815 public function invalidateCache() {
2817 $this->clearSharedCache();
2821 * Update the "touched" timestamp for the user
2823 * This is useful on various login/logout events when making sure that
2824 * a browser or proxy that has multiple tenants does not suffer cache
2825 * pollution where the new user sees the old users content. The value
2826 * of getTouched() is checked when determining 304 vs 200 responses.
2827 * Unlike invalidateCache(), this preserves the User object cache and
2828 * avoids database writes.
2832 public function touch() {
2833 $id = $this->getId();
2835 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2836 $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
2837 $cache->touchCheckKey( $key );
2838 $this->mQuickTouched
= null;
2843 * Validate the cache for this account.
2844 * @param string $timestamp A timestamp in TS_MW format
2847 public function validateCache( $timestamp ) {
2848 return ( $timestamp >= $this->getTouched() );
2852 * Get the user touched timestamp
2854 * Use this value only to validate caches via inequalities
2855 * such as in the case of HTTP If-Modified-Since response logic
2857 * @return string TS_MW Timestamp
2859 public function getTouched() {
2863 if ( $this->mQuickTouched
=== null ) {
2864 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2865 $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId
);
2867 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2870 return max( $this->mTouched
, $this->mQuickTouched
);
2873 return $this->mTouched
;
2877 * Get the user_touched timestamp field (time of last DB updates)
2878 * @return string TS_MW Timestamp
2881 public function getDBTouched() {
2884 return $this->mTouched
;
2888 * Set the password and reset the random token.
2889 * Calls through to authentication plugin if necessary;
2890 * will have no effect if the auth plugin refuses to
2891 * pass the change through or if the legal password
2894 * As a special case, setting the password to null
2895 * wipes it, so the account cannot be logged in until
2896 * a new password is set, for instance via e-mail.
2898 * @deprecated since 1.27, use AuthManager instead
2899 * @param string $str New password to set
2900 * @throws PasswordError On failure
2903 public function setPassword( $str ) {
2904 wfDeprecated( __METHOD__
, '1.27' );
2905 return $this->setPasswordInternal( $str );
2909 * Set the password and reset the random token unconditionally.
2911 * @deprecated since 1.27, use AuthManager instead
2912 * @param string|null $str New password to set or null to set an invalid
2913 * password hash meaning that the user will not be able to log in
2914 * through the web interface.
2916 public function setInternalPassword( $str ) {
2917 wfDeprecated( __METHOD__
, '1.27' );
2918 $this->setPasswordInternal( $str );
2922 * Actually set the password and such
2923 * @since 1.27 cannot set a password for a user not in the database
2924 * @param string|null $str New password to set or null to set an invalid
2925 * password hash meaning that the user will not be able to log in
2926 * through the web interface.
2927 * @return bool Success
2929 private function setPasswordInternal( $str ) {
2930 $manager = AuthManager
::singleton();
2932 // If the user doesn't exist yet, fail
2933 if ( !$manager->userExists( $this->getName() ) ) {
2934 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2937 $status = $this->changeAuthenticationData( [
2938 'username' => $this->getName(),
2942 if ( !$status->isGood() ) {
2943 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2944 ->info( __METHOD__
. ': Password change rejected: '
2945 . $status->getWikiText( null, null, 'en' ) );
2949 $this->setOption( 'watchlisttoken', false );
2950 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2956 * Changes credentials of the user.
2958 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2959 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2960 * e.g. when no provider handled the change.
2962 * @param array $data A set of authentication data in fieldname => value format. This is the
2963 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2967 public function changeAuthenticationData( array $data ) {
2968 $manager = AuthManager
::singleton();
2969 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2970 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2972 $status = Status
::newGood( 'ignored' );
2973 foreach ( $reqs as $req ) {
2974 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2976 if ( $status->getValue() === 'ignored' ) {
2977 $status->warning( 'authenticationdatachange-ignored' );
2980 if ( $status->isGood() ) {
2981 foreach ( $reqs as $req ) {
2982 $manager->changeAuthenticationData( $req );
2989 * Get the user's current token.
2990 * @param bool $forceCreation Force the generation of a new token if the
2991 * user doesn't have one (default=true for backwards compatibility).
2992 * @return string|null Token
2994 public function getToken( $forceCreation = true ) {
2995 global $wgAuthenticationTokenVersion;
2998 if ( !$this->mToken
&& $forceCreation ) {
3002 if ( !$this->mToken
) {
3003 // The user doesn't have a token, return null to indicate that.
3007 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
3008 // We return a random value here so existing token checks are very
3010 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3013 if ( $wgAuthenticationTokenVersion === null ) {
3014 // $wgAuthenticationTokenVersion not in use, so return the raw secret
3015 return $this->mToken
;
3018 // $wgAuthenticationTokenVersion in use, so hmac it.
3019 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
3021 // The raw hash can be overly long. Shorten it up.
3022 $len = max( 32, self
::TOKEN_LENGTH
);
3023 if ( strlen( $ret ) < $len ) {
3024 // Should never happen, even md5 is 128 bits
3025 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
3028 return substr( $ret, -$len );
3032 * Set the random token (used for persistent authentication)
3033 * Called from loadDefaults() among other places.
3035 * @param string|bool $token If specified, set the token to this value
3037 public function setToken( $token = false ) {
3039 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
3040 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3041 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
3042 } elseif ( !$token ) {
3043 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3045 $this->mToken
= $token;
3050 * Set the password for a password reminder or new account email
3052 * @deprecated Removed in 1.27. Use PasswordReset instead.
3053 * @param string $str New password to set or null to set an invalid
3054 * password hash meaning that the user will not be able to use it
3055 * @param bool $throttle If true, reset the throttle timestamp to the present
3057 public function setNewpassword( $str, $throttle = true ) {
3058 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
3062 * Get the user's e-mail address
3063 * @return string User's email address
3065 public function getEmail() {
3067 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
3068 return $this->mEmail
;
3072 * Get the timestamp of the user's e-mail authentication
3073 * @return string TS_MW timestamp
3075 public function getEmailAuthenticationTimestamp() {
3077 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
3078 return $this->mEmailAuthenticated
;
3082 * Set the user's e-mail address
3083 * @param string $str New e-mail address
3085 public function setEmail( $str ) {
3087 if ( $str == $this->mEmail
) {
3090 $this->invalidateEmail();
3091 $this->mEmail
= $str;
3092 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
3096 * Set the user's e-mail address and a confirmation mail if needed.
3099 * @param string $str New e-mail address
3102 public function setEmailWithConfirmation( $str ) {
3103 global $wgEnableEmail, $wgEmailAuthentication;
3105 if ( !$wgEnableEmail ) {
3106 return Status
::newFatal( 'emaildisabled' );
3109 $oldaddr = $this->getEmail();
3110 if ( $str === $oldaddr ) {
3111 return Status
::newGood( true );
3114 $type = $oldaddr != '' ?
'changed' : 'set';
3115 $notificationResult = null;
3117 if ( $wgEmailAuthentication && $type === 'changed' ) {
3118 // Send the user an email notifying the user of the change in registered
3119 // email address on their previous email address
3120 $change = $str != '' ?
'changed' : 'removed';
3121 $notificationResult = $this->sendMail(
3122 wfMessage( 'notificationemail_subject_' . $change )->text(),
3123 wfMessage( 'notificationemail_body_' . $change,
3124 $this->getRequest()->getIP(),
3130 $this->setEmail( $str );
3132 if ( $str !== '' && $wgEmailAuthentication ) {
3133 // Send a confirmation request to the new address if needed
3134 $result = $this->sendConfirmationMail( $type );
3136 if ( $notificationResult !== null ) {
3137 $result->merge( $notificationResult );
3140 if ( $result->isGood() ) {
3141 // Say to the caller that a confirmation and notification mail has been sent
3142 $result->value
= 'eauth';
3145 $result = Status
::newGood( true );
3152 * Get the user's real name
3153 * @return string User's real name
3155 public function getRealName() {
3156 if ( !$this->isItemLoaded( 'realname' ) ) {
3160 return $this->mRealName
;
3164 * Set the user's real name
3165 * @param string $str New real name
3167 public function setRealName( $str ) {
3169 $this->mRealName
= $str;
3173 * Get the user's current setting for a given option.
3175 * @param string $oname The option to check
3176 * @param string|array|null $defaultOverride A default value returned if the option does not exist
3177 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
3178 * @return string|array|int|null User's current value for the option
3179 * @see getBoolOption()
3180 * @see getIntOption()
3182 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
3183 global $wgHiddenPrefs;
3184 $this->loadOptions();
3186 # We want 'disabled' preferences to always behave as the default value for
3187 # users, even if they have set the option explicitly in their settings (ie they
3188 # set it, and then it was disabled removing their ability to change it). But
3189 # we don't want to erase the preferences in the database in case the preference
3190 # is re-enabled again. So don't touch $mOptions, just override the returned value
3191 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
3192 return self
::getDefaultOption( $oname );
3195 if ( array_key_exists( $oname, $this->mOptions
) ) {
3196 return $this->mOptions
[$oname];
3199 return $defaultOverride;
3203 * Get all user's options
3205 * @param int $flags Bitwise combination of:
3206 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
3207 * to the default value. (Since 1.25)
3210 public function getOptions( $flags = 0 ) {
3211 global $wgHiddenPrefs;
3212 $this->loadOptions();
3213 $options = $this->mOptions
;
3215 # We want 'disabled' preferences to always behave as the default value for
3216 # users, even if they have set the option explicitly in their settings (ie they
3217 # set it, and then it was disabled removing their ability to change it). But
3218 # we don't want to erase the preferences in the database in case the preference
3219 # is re-enabled again. So don't touch $mOptions, just override the returned value
3220 foreach ( $wgHiddenPrefs as $pref ) {
3221 $default = self
::getDefaultOption( $pref );
3222 if ( $default !== null ) {
3223 $options[$pref] = $default;
3227 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
3228 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
3235 * Get the user's current setting for a given option, as a boolean value.
3237 * @param string $oname The option to check
3238 * @return bool User's current value for the option
3241 public function getBoolOption( $oname ) {
3242 return (bool)$this->getOption( $oname );
3246 * Get the user's current setting for a given option, as an integer value.
3248 * @param string $oname The option to check
3249 * @param int $defaultOverride A default value returned if the option does not exist
3250 * @return int User's current value for the option
3253 public function getIntOption( $oname, $defaultOverride = 0 ) {
3254 $val = $this->getOption( $oname );
3256 $val = $defaultOverride;
3258 return intval( $val );
3262 * Set the given option for a user.
3264 * You need to call saveSettings() to actually write to the database.
3266 * @param string $oname The option to set
3267 * @param mixed $val New value to set
3269 public function setOption( $oname, $val ) {
3270 $this->loadOptions();
3272 // Explicitly NULL values should refer to defaults
3273 if ( is_null( $val ) ) {
3274 $val = self
::getDefaultOption( $oname );
3277 $this->mOptions
[$oname] = $val;
3281 * Get a token stored in the preferences (like the watchlist one),
3282 * resetting it if it's empty (and saving changes).
3284 * @param string $oname The option name to retrieve the token from
3285 * @return string|bool User's current value for the option, or false if this option is disabled.
3286 * @see resetTokenFromOption()
3288 * @deprecated since 1.26 Applications should use the OAuth extension
3290 public function getTokenFromOption( $oname ) {
3291 global $wgHiddenPrefs;
3293 $id = $this->getId();
3294 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
3298 $token = $this->getOption( $oname );
3300 // Default to a value based on the user token to avoid space
3301 // wasted on storing tokens for all users. When this option
3302 // is set manually by the user, only then is it stored.
3303 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
3310 * Reset a token stored in the preferences (like the watchlist one).
3311 * *Does not* save user's preferences (similarly to setOption()).
3313 * @param string $oname The option name to reset the token in
3314 * @return string|bool New token value, or false if this option is disabled.
3315 * @see getTokenFromOption()
3318 public function resetTokenFromOption( $oname ) {
3319 global $wgHiddenPrefs;
3320 if ( in_array( $oname, $wgHiddenPrefs ) ) {
3324 $token = MWCryptRand
::generateHex( 40 );
3325 $this->setOption( $oname, $token );
3330 * Return a list of the types of user options currently returned by
3331 * User::getOptionKinds().
3333 * Currently, the option kinds are:
3334 * - 'registered' - preferences which are registered in core MediaWiki or
3335 * by extensions using the UserGetDefaultOptions hook.
3336 * - 'registered-multiselect' - as above, using the 'multiselect' type.
3337 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
3338 * - 'userjs' - preferences with names starting with 'userjs-', intended to
3339 * be used by user scripts.
3340 * - 'special' - "preferences" that are not accessible via User::getOptions
3341 * or User::setOptions.
3342 * - 'unused' - preferences about which MediaWiki doesn't know anything.
3343 * These are usually legacy options, removed in newer versions.
3345 * The API (and possibly others) use this function to determine the possible
3346 * option types for validation purposes, so make sure to update this when a
3347 * new option kind is added.
3349 * @see User::getOptionKinds
3350 * @return array Option kinds
3352 public static function listOptionKinds() {
3355 'registered-multiselect',
3356 'registered-checkmatrix',
3364 * Return an associative array mapping preferences keys to the kind of a preference they're
3365 * used for. Different kinds are handled differently when setting or reading preferences.
3367 * See User::listOptionKinds for the list of valid option types that can be provided.
3369 * @see User::listOptionKinds
3370 * @param IContextSource $context
3371 * @param array|null $options Assoc. array with options keys to check as keys.
3372 * Defaults to $this->mOptions.
3373 * @return array The key => kind mapping data
3375 public function getOptionKinds( IContextSource
$context, $options = null ) {
3376 $this->loadOptions();
3377 if ( $options === null ) {
3378 $options = $this->mOptions
;
3381 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
3382 $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
3385 // Pull out the "special" options, so they don't get converted as
3386 // multiselect or checkmatrix.
3387 $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
3388 foreach ( $specialOptions as $name => $value ) {
3389 unset( $prefs[$name] );
3392 // Multiselect and checkmatrix options are stored in the database with
3393 // one key per option, each having a boolean value. Extract those keys.
3394 $multiselectOptions = [];
3395 foreach ( $prefs as $name => $info ) {
3396 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3397 ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField
::class ) ) {
3398 $opts = HTMLFormField
::flattenOptions( $info['options'] );
3399 $prefix = $info['prefix'] ??
$name;
3401 foreach ( $opts as $value ) {
3402 $multiselectOptions["$prefix$value"] = true;
3405 unset( $prefs[$name] );
3408 $checkmatrixOptions = [];
3409 foreach ( $prefs as $name => $info ) {
3410 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3411 ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix
::class ) ) {
3412 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3413 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3414 $prefix = $info['prefix'] ??
$name;
3416 foreach ( $columns as $column ) {
3417 foreach ( $rows as $row ) {
3418 $checkmatrixOptions["$prefix$column-$row"] = true;
3422 unset( $prefs[$name] );
3426 // $value is ignored
3427 foreach ( $options as $key => $value ) {
3428 if ( isset( $prefs[$key] ) ) {
3429 $mapping[$key] = 'registered';
3430 } elseif ( isset( $multiselectOptions[$key] ) ) {
3431 $mapping[$key] = 'registered-multiselect';
3432 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3433 $mapping[$key] = 'registered-checkmatrix';
3434 } elseif ( isset( $specialOptions[$key] ) ) {
3435 $mapping[$key] = 'special';
3436 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3437 $mapping[$key] = 'userjs';
3439 $mapping[$key] = 'unused';
3447 * Reset certain (or all) options to the site defaults
3449 * The optional parameter determines which kinds of preferences will be reset.
3450 * Supported values are everything that can be reported by getOptionKinds()
3451 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3453 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3454 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3455 * for backwards-compatibility.
3456 * @param IContextSource|null $context Context source used when $resetKinds
3457 * does not contain 'all', passed to getOptionKinds().
3458 * Defaults to RequestContext::getMain() when null.
3460 public function resetOptions(
3461 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3462 IContextSource
$context = null
3465 $defaultOptions = self
::getDefaultOptions();
3467 if ( !is_array( $resetKinds ) ) {
3468 $resetKinds = [ $resetKinds ];
3471 if ( in_array( 'all', $resetKinds ) ) {
3472 $newOptions = $defaultOptions;
3474 if ( $context === null ) {
3475 $context = RequestContext
::getMain();
3478 $optionKinds = $this->getOptionKinds( $context );
3479 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3482 // Use default values for the options that should be deleted, and
3483 // copy old values for the ones that shouldn't.
3484 foreach ( $this->mOptions
as $key => $value ) {
3485 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3486 if ( array_key_exists( $key, $defaultOptions ) ) {
3487 $newOptions[$key] = $defaultOptions[$key];
3490 $newOptions[$key] = $value;
3495 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3497 $this->mOptions
= $newOptions;
3498 $this->mOptionsLoaded
= true;
3502 * Get the user's preferred date format.
3503 * @return string User's preferred date format
3505 public function getDatePreference() {
3506 // Important migration for old data rows
3507 if ( is_null( $this->mDatePreference
) ) {
3509 $value = $this->getOption( 'date' );
3510 $map = $wgLang->getDatePreferenceMigrationMap();
3511 if ( isset( $map[$value] ) ) {
3512 $value = $map[$value];
3514 $this->mDatePreference
= $value;
3516 return $this->mDatePreference
;
3520 * Determine based on the wiki configuration and the user's options,
3521 * whether this user must be over HTTPS no matter what.
3525 public function requiresHTTPS() {
3526 global $wgSecureLogin;
3527 if ( !$wgSecureLogin ) {
3531 $https = $this->getBoolOption( 'prefershttps' );
3532 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3534 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3541 * Get the user preferred stub threshold
3545 public function getStubThreshold() {
3546 global $wgMaxArticleSize; # Maximum article size, in Kb
3547 $threshold = $this->getIntOption( 'stubthreshold' );
3548 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3549 // If they have set an impossible value, disable the preference
3550 // so we can use the parser cache again.
3557 * Get the permissions this user has.
3558 * @return string[] permission names
3560 public function getRights() {
3561 if ( is_null( $this->mRights
) ) {
3562 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3563 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3565 // Deny any rights denied by the user's session, unless this
3566 // endpoint has no sessions.
3567 if ( !defined( 'MW_NO_SESSION' ) ) {
3568 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3569 if ( $allowedRights !== null ) {
3570 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3574 Hooks
::run( 'UserGetRightsRemove', [ $this, &$this->mRights
] );
3575 // Force reindexation of rights when a hook has unset one of them
3576 $this->mRights
= array_values( array_unique( $this->mRights
) );
3578 // If block disables login, we should also remove any
3579 // extra rights blocked users might have, in case the
3580 // blocked user has a pre-existing session (T129738).
3581 // This is checked here for cases where people only call
3582 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3583 // to give a better error message in the common case.
3584 $config = RequestContext
::getMain()->getConfig();
3586 $this->isLoggedIn() &&
3587 $config->get( 'BlockDisablesLogin' ) &&
3591 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3594 return $this->mRights
;
3598 * Get the list of explicit group memberships this user has.
3599 * The implicit * and user groups are not included.
3601 * @return string[] Array of internal group names (sorted since 1.33)
3603 public function getGroups() {
3605 $this->loadGroups();
3606 return array_keys( $this->mGroupMemberships
);
3610 * Get the list of explicit group memberships this user has, stored as
3611 * UserGroupMembership objects. Implicit groups are not included.
3613 * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
3616 public function getGroupMemberships() {
3618 $this->loadGroups();
3619 return $this->mGroupMemberships
;
3623 * Get the list of implicit group memberships this user has.
3624 * This includes all explicit groups, plus 'user' if logged in,
3625 * '*' for all accounts, and autopromoted groups
3626 * @param bool $recache Whether to avoid the cache
3627 * @return array Array of String internal group names
3629 public function getEffectiveGroups( $recache = false ) {
3630 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3631 $this->mEffectiveGroups
= array_unique( array_merge(
3632 $this->getGroups(), // explicit groups
3633 $this->getAutomaticGroups( $recache ) // implicit groups
3635 // Avoid PHP 7.1 warning of passing $this by reference
3637 // Hook for additional groups
3638 Hooks
::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups
] );
3639 // Force reindexation of groups when a hook has unset one of them
3640 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3642 return $this->mEffectiveGroups
;
3646 * Get the list of implicit group memberships this user has.
3647 * This includes 'user' if logged in, '*' for all accounts,
3648 * and autopromoted groups
3649 * @param bool $recache Whether to avoid the cache
3650 * @return array Array of String internal group names
3652 public function getAutomaticGroups( $recache = false ) {
3653 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3654 $this->mImplicitGroups
= [ '*' ];
3655 if ( $this->getId() ) {
3656 $this->mImplicitGroups
[] = 'user';
3658 $this->mImplicitGroups
= array_unique( array_merge(
3659 $this->mImplicitGroups
,
3660 Autopromote
::getAutopromoteGroups( $this )
3664 // Assure data consistency with rights/groups,
3665 // as getEffectiveGroups() depends on this function
3666 $this->mEffectiveGroups
= null;
3669 return $this->mImplicitGroups
;
3673 * Returns the groups the user has belonged to.
3675 * The user may still belong to the returned groups. Compare with getGroups().
3677 * The function will not return groups the user had belonged to before MW 1.17
3679 * @return array Names of the groups the user has belonged to.
3681 public function getFormerGroups() {
3684 if ( is_null( $this->mFormerGroups
) ) {
3685 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3686 ?
wfGetDB( DB_MASTER
)
3687 : wfGetDB( DB_REPLICA
);
3688 $res = $db->select( 'user_former_groups',
3690 [ 'ufg_user' => $this->mId
],
3692 $this->mFormerGroups
= [];
3693 foreach ( $res as $row ) {
3694 $this->mFormerGroups
[] = $row->ufg_group
;
3698 return $this->mFormerGroups
;
3702 * Get the user's edit count.
3703 * @return int|null Null for anonymous users
3705 public function getEditCount() {
3706 if ( !$this->getId() ) {
3710 if ( $this->mEditCount
=== null ) {
3711 /* Populate the count, if it has not been populated yet */
3712 $dbr = wfGetDB( DB_REPLICA
);
3713 // check if the user_editcount field has been initialized
3714 $count = $dbr->selectField(
3715 'user', 'user_editcount',
3716 [ 'user_id' => $this->mId
],
3720 if ( $count === null ) {
3721 // it has not been initialized. do so.
3722 $count = $this->initEditCountInternal();
3724 $this->mEditCount
= $count;
3726 return (int)$this->mEditCount
;
3730 * Add the user to the given group. This takes immediate effect.
3731 * If the user is already in the group, the expiry time will be updated to the new
3732 * expiry time. (If $expiry is omitted or null, the membership will be altered to
3735 * @param string $group Name of the group to add
3736 * @param string|null $expiry Optional expiry timestamp in any format acceptable to
3737 * wfTimestamp(), or null if the group assignment should not expire
3740 public function addGroup( $group, $expiry = null ) {
3742 $this->loadGroups();
3745 $expiry = wfTimestamp( TS_MW
, $expiry );
3748 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
3752 // create the new UserGroupMembership and put it in the DB
3753 $ugm = new UserGroupMembership( $this->mId
, $group, $expiry );
3754 if ( !$ugm->insert( true ) ) {
3758 $this->mGroupMemberships
[$group] = $ugm;
3760 // Refresh the groups caches, and clear the rights cache so it will be
3761 // refreshed on the next call to $this->getRights().
3762 $this->getEffectiveGroups( true );
3763 $this->mRights
= null;
3765 $this->invalidateCache();
3771 * Remove the user from the given group.
3772 * This takes immediate effect.
3773 * @param string $group Name of the group to remove
3776 public function removeGroup( $group ) {
3779 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3783 $ugm = UserGroupMembership
::getMembership( $this->mId
, $group );
3784 // delete the membership entry
3785 if ( !$ugm ||
!$ugm->delete() ) {
3789 $this->loadGroups();
3790 unset( $this->mGroupMemberships
[$group] );
3792 // Refresh the groups caches, and clear the rights cache so it will be
3793 // refreshed on the next call to $this->getRights().
3794 $this->getEffectiveGroups( true );
3795 $this->mRights
= null;
3797 $this->invalidateCache();
3803 * Get whether the user is logged in
3806 public function isLoggedIn() {
3807 return $this->getId() != 0;
3811 * Get whether the user is anonymous
3814 public function isAnon() {
3815 return !$this->isLoggedIn();
3819 * @return bool Whether this user is flagged as being a bot role account
3822 public function isBot() {
3823 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3828 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3834 * Check if user is allowed to access a feature / make an action
3836 * @param string $permissions,... Permissions to test
3837 * @return bool True if user is allowed to perform *any* of the given actions
3839 public function isAllowedAny() {
3840 $permissions = func_get_args();
3841 foreach ( $permissions as $permission ) {
3842 if ( $this->isAllowed( $permission ) ) {
3851 * @param string $permissions,... Permissions to test
3852 * @return bool True if the user is allowed to perform *all* of the given actions
3854 public function isAllowedAll() {
3855 $permissions = func_get_args();
3856 foreach ( $permissions as $permission ) {
3857 if ( !$this->isAllowed( $permission ) ) {
3865 * Internal mechanics of testing a permission
3866 * @param string $action
3869 public function isAllowed( $action = '' ) {
3870 if ( $action === '' ) {
3871 return true; // In the spirit of DWIM
3873 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3874 // by misconfiguration: 0 == 'foo'
3875 return in_array( $action, $this->getRights(), true );
3879 * Check whether to enable recent changes patrol features for this user
3880 * @return bool True or false
3882 public function useRCPatrol() {
3883 global $wgUseRCPatrol;
3884 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3888 * Check whether to enable new pages patrol features for this user
3889 * @return bool True or false
3891 public function useNPPatrol() {
3892 global $wgUseRCPatrol, $wgUseNPPatrol;
3894 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3895 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3900 * Check whether to enable new files patrol features for this user
3901 * @return bool True or false
3903 public function useFilePatrol() {
3904 global $wgUseRCPatrol, $wgUseFilePatrol;
3906 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3907 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3912 * Get the WebRequest object to use with this object
3914 * @return WebRequest
3916 public function getRequest() {
3917 if ( $this->mRequest
) {
3918 return $this->mRequest
;
3926 * Check the watched status of an article.
3927 * @since 1.22 $checkRights parameter added
3928 * @param Title $title Title of the article to look at
3929 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3930 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3933 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3934 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3935 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
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 addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3948 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3949 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3951 [ $title->getSubjectPage(), $title->getTalkPage() ]
3954 $this->invalidateCache();
3958 * Stop watching an article.
3959 * @since 1.22 $checkRights parameter added
3960 * @param Title $title Title of the article to look at
3961 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3962 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3964 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3965 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3966 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3967 $store->removeWatch( $this, $title->getSubjectPage() );
3968 $store->removeWatch( $this, $title->getTalkPage() );
3970 $this->invalidateCache();
3974 * Clear the user's notification timestamp for the given title.
3975 * If e-notif e-mails are on, they will receive notification mails on
3976 * the next change of the page if it's watched etc.
3977 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3978 * @param Title &$title Title of the article to look at
3979 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3981 public function clearNotification( &$title, $oldid = 0 ) {
3982 global $wgUseEnotif, $wgShowUpdatedMarker;
3984 // Do nothing if the database is locked to writes
3985 if ( wfReadOnly() ) {
3989 // Do nothing if not allowed to edit the watchlist
3990 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3994 // If we're working on user's talk page, we should update the talk page message indicator
3995 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3996 // Avoid PHP 7.1 warning of passing $this by reference
3998 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
4002 // Try to update the DB post-send and only if needed...
4003 DeferredUpdates
::addCallableUpdate( function () use ( $title, $oldid ) {
4004 if ( !$this->getNewtalk() ) {
4005 return; // no notifications to clear
4008 // Delete the last notifications (they stack up)
4009 $this->setNewtalk( false );
4011 // If there is a new, unseen, revision, use its timestamp
4013 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
4016 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
4021 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4025 if ( $this->isAnon() ) {
4026 // Nothing else to do...
4030 // Only update the timestamp if the page is being watched.
4031 // The query to find out if it is watched is cached both in memcached and per-invocation,
4032 // and when it does have to be executed, it can be on a replica DB
4033 // If this is the user's newtalk page, we always update the timestamp
4035 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
4039 MediaWikiServices
::getInstance()->getWatchedItemStore()
4040 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
4044 * Resets all of the given user's page-change notification timestamps.
4045 * If e-notif e-mails are on, they will receive notification mails on
4046 * the next change of any watched page.
4047 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
4049 public function clearAllNotifications() {
4050 global $wgUseEnotif, $wgShowUpdatedMarker;
4051 // Do nothing if not allowed to edit the watchlist
4052 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
4056 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4057 $this->setNewtalk( false );
4061 $id = $this->getId();
4066 $watchedItemStore = MediaWikiServices
::getInstance()->getWatchedItemStore();
4067 $watchedItemStore->resetAllNotificationTimestampsForUser( $this );
4069 // We also need to clear here the "you have new message" notification for the own
4070 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
4074 * Compute experienced level based on edit count and registration date.
4076 * @return string 'newcomer', 'learner', or 'experienced'
4078 public function getExperienceLevel() {
4079 global $wgLearnerEdits,
4080 $wgExperiencedUserEdits,
4081 $wgLearnerMemberSince,
4082 $wgExperiencedUserMemberSince;
4084 if ( $this->isAnon() ) {
4088 $editCount = $this->getEditCount();
4089 $registration = $this->getRegistration();
4091 $learnerRegistration = wfTimestamp( TS_MW
, $now - $wgLearnerMemberSince * 86400 );
4092 $experiencedRegistration = wfTimestamp( TS_MW
, $now - $wgExperiencedUserMemberSince * 86400 );
4094 if ( $editCount < $wgLearnerEdits ||
4095 $registration > $learnerRegistration ) {
4099 if ( $editCount > $wgExperiencedUserEdits &&
4100 $registration <= $experiencedRegistration
4102 return 'experienced';
4109 * Persist this user's session (e.g. set cookies)
4111 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
4113 * @param bool|null $secure Whether to force secure/insecure cookies or use default
4114 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
4116 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
4118 if ( $this->mId
== 0 ) {
4122 $session = $this->getRequest()->getSession();
4123 if ( $request && $session->getRequest() !== $request ) {
4124 $session = $session->sessionWithRequest( $request );
4126 $delay = $session->delaySave();
4128 if ( !$session->getUser()->equals( $this ) ) {
4129 if ( !$session->canSetUser() ) {
4130 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4131 ->warning( __METHOD__
.
4132 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
4136 $session->setUser( $this );
4139 $session->setRememberUser( $rememberMe );
4140 if ( $secure !== null ) {
4141 $session->setForceHTTPS( $secure );
4144 $session->persist();
4146 ScopedCallback
::consume( $delay );
4150 * Log this user out.
4152 public function logout() {
4153 // Avoid PHP 7.1 warning of passing $this by reference
4155 if ( Hooks
::run( 'UserLogout', [ &$user ] ) ) {
4161 * Clear the user's session, and reset the instance cache.
4164 public function doLogout() {
4165 $session = $this->getRequest()->getSession();
4166 if ( !$session->canSetUser() ) {
4167 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4168 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
4169 $error = 'immutable';
4170 } elseif ( !$session->getUser()->equals( $this ) ) {
4171 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4172 ->warning( __METHOD__
.
4173 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
4175 // But we still may as well make this user object anon
4176 $this->clearInstanceCache( 'defaults' );
4177 $error = 'wronguser';
4179 $this->clearInstanceCache( 'defaults' );
4180 $delay = $session->delaySave();
4181 $session->unpersist(); // Clear cookies (T127436)
4182 $session->setLoggedOutTimestamp( time() );
4183 $session->setUser( new User
);
4184 $session->set( 'wsUserID', 0 ); // Other code expects this
4185 $session->resetAllTokens();
4186 ScopedCallback
::consume( $delay );
4189 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
4190 'event' => 'logout',
4191 'successful' => $error === false,
4192 'status' => $error ?
: 'success',
4197 * Save this user's settings into the database.
4198 * @todo Only rarely do all these fields need to be set!
4200 public function saveSettings() {
4201 if ( wfReadOnly() ) {
4202 // @TODO: caller should deal with this instead!
4203 // This should really just be an exception.
4204 MWExceptionHandler
::logException( new DBExpectedError(
4206 "Could not update user with ID '{$this->mId}'; DB is read-only."
4212 if ( $this->mId
== 0 ) {
4216 // Get a new user_touched that is higher than the old one.
4217 // This will be used for a CAS check as a last-resort safety
4218 // check against race conditions and replica DB lag.
4219 $newTouched = $this->newTouchedTimestamp();
4221 $dbw = wfGetDB( DB_MASTER
);
4222 $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $newTouched ) {
4223 global $wgActorTableSchemaMigrationStage;
4225 $dbw->update( 'user',
4227 'user_name' => $this->mName
,
4228 'user_real_name' => $this->mRealName
,
4229 'user_email' => $this->mEmail
,
4230 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4231 'user_touched' => $dbw->timestamp( $newTouched ),
4232 'user_token' => strval( $this->mToken
),
4233 'user_email_token' => $this->mEmailToken
,
4234 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
4235 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
4236 'user_id' => $this->mId
,
4240 if ( !$dbw->affectedRows() ) {
4241 // Maybe the problem was a missed cache update; clear it to be safe
4242 $this->clearSharedCache( 'refresh' );
4243 // User was changed in the meantime or loaded with stale data
4244 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
4245 LoggerFactory
::getInstance( 'preferences' )->warning(
4246 "CAS update failed on user_touched for user ID '{user_id}' ({db_flag} read)",
4247 [ 'user_id' => $this->mId
, 'db_flag' => $from ]
4249 throw new MWException( "CAS update failed on user_touched. " .
4250 "The version of the user to be saved is older than the current version."
4254 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4257 [ 'actor_name' => $this->mName
],
4258 [ 'actor_user' => $this->mId
],
4264 $this->mTouched
= $newTouched;
4265 $this->saveOptions();
4267 Hooks
::run( 'UserSaveSettings', [ $this ] );
4268 $this->clearSharedCache();
4269 $this->getUserPage()->invalidateCache();
4273 * If only this user's username is known, and it exists, return the user ID.
4275 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
4278 public function idForName( $flags = 0 ) {
4279 $s = trim( $this->getName() );
4284 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
4285 ?
wfGetDB( DB_MASTER
)
4286 : wfGetDB( DB_REPLICA
);
4288 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
4289 ?
[ 'LOCK IN SHARE MODE' ]
4292 $id = $db->selectField( 'user',
4293 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
4299 * Add a user to the database, return the user object
4301 * @param string $name Username to add
4302 * @param array $params Array of Strings Non-default parameters to save to
4303 * the database as user_* fields:
4304 * - email: The user's email address.
4305 * - email_authenticated: The email authentication timestamp.
4306 * - real_name: The user's real name.
4307 * - options: An associative array of non-default options.
4308 * - token: Random authentication token. Do not set.
4309 * - registration: Registration timestamp. Do not set.
4311 * @return User|null User object, or null if the username already exists.
4313 public static function createNew( $name, $params = [] ) {
4314 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
4315 if ( isset( $params[$field] ) ) {
4316 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
4317 unset( $params[$field] );
4323 $user->setToken(); // init token
4324 if ( isset( $params['options'] ) ) {
4325 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
4326 unset( $params['options'] );
4328 $dbw = wfGetDB( DB_MASTER
);
4330 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4333 'user_name' => $name,
4334 'user_password' => $noPass,
4335 'user_newpassword' => $noPass,
4336 'user_email' => $user->mEmail
,
4337 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
4338 'user_real_name' => $user->mRealName
,
4339 'user_token' => strval( $user->mToken
),
4340 'user_registration' => $dbw->timestamp( $user->mRegistration
),
4341 'user_editcount' => 0,
4342 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4344 foreach ( $params as $name => $value ) {
4345 $fields["user_$name"] = $value;
4348 return $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $fields ) {
4349 $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
4350 if ( $dbw->affectedRows() ) {
4351 $newUser = self
::newFromId( $dbw->insertId() );
4352 $newUser->mName
= $fields['user_name'];
4353 $newUser->updateActorId( $dbw );
4354 // Load the user from master to avoid replica lag
4355 $newUser->load( self
::READ_LATEST
);
4364 * Add this existing user object to the database. If the user already
4365 * exists, a fatal status object is returned, and the user object is
4366 * initialised with the data from the database.
4368 * Previously, this function generated a DB error due to a key conflict
4369 * if the user already existed. Many extension callers use this function
4370 * in code along the lines of:
4372 * $user = User::newFromName( $name );
4373 * if ( !$user->isLoggedIn() ) {
4374 * $user->addToDatabase();
4376 * // do something with $user...
4378 * However, this was vulnerable to a race condition (T18020). By
4379 * initialising the user object if the user exists, we aim to support this
4380 * calling sequence as far as possible.
4382 * Note that if the user exists, this function will acquire a write lock,
4383 * so it is still advisable to make the call conditional on isLoggedIn(),
4384 * and to commit the transaction after calling.
4386 * @throws MWException
4389 public function addToDatabase() {
4391 if ( !$this->mToken
) {
4392 $this->setToken(); // init token
4395 if ( !is_string( $this->mName
) ) {
4396 throw new RuntimeException( "User name field is not set." );
4399 $this->mTouched
= $this->newTouchedTimestamp();
4401 $dbw = wfGetDB( DB_MASTER
);
4402 $status = $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) {
4403 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4404 $dbw->insert( 'user',
4406 'user_name' => $this->mName
,
4407 'user_password' => $noPass,
4408 'user_newpassword' => $noPass,
4409 'user_email' => $this->mEmail
,
4410 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4411 'user_real_name' => $this->mRealName
,
4412 'user_token' => strval( $this->mToken
),
4413 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4414 'user_editcount' => 0,
4415 'user_touched' => $dbw->timestamp( $this->mTouched
),
4419 if ( !$dbw->affectedRows() ) {
4420 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4421 $this->mId
= $dbw->selectField(
4424 [ 'user_name' => $this->mName
],
4426 [ 'LOCK IN SHARE MODE' ]
4430 if ( $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4435 throw new MWException( $fname . ": hit a key conflict attempting " .
4436 "to insert user '{$this->mName}' row, but it was not present in select!" );
4438 return Status
::newFatal( 'userexists' );
4440 $this->mId
= $dbw->insertId();
4441 self
::$idCacheByName[$this->mName
] = $this->mId
;
4442 $this->updateActorId( $dbw );
4444 return Status
::newGood();
4446 if ( !$status->isGood() ) {
4450 // Clear instance cache other than user table data and actor, which is already accurate
4451 $this->clearInstanceCache();
4453 $this->saveOptions();
4454 return Status
::newGood();
4458 * Update the actor ID after an insert
4459 * @param IDatabase $dbw Writable database handle
4461 private function updateActorId( IDatabase
$dbw ) {
4462 global $wgActorTableSchemaMigrationStage;
4464 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4467 [ 'actor_user' => $this->mId
, 'actor_name' => $this->mName
],
4470 $this->mActorId
= (int)$dbw->insertId();
4475 * If this user is logged-in and blocked,
4476 * block any IP address they've successfully logged in from.
4477 * @return bool A block was spread
4479 public function spreadAnyEditBlock() {
4480 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4481 return $this->spreadBlock();
4488 * If this (non-anonymous) user is blocked,
4489 * block the IP address they've successfully logged in from.
4490 * @return bool A block was spread
4492 protected function spreadBlock() {
4493 wfDebug( __METHOD__
. "()\n" );
4495 if ( $this->mId
== 0 ) {
4499 $userblock = Block
::newFromTarget( $this->getName() );
4500 if ( !$userblock ) {
4504 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4508 * Get whether the user is explicitly blocked from account creation.
4509 * @return bool|Block
4511 public function isBlockedFromCreateAccount() {
4512 $this->getBlockedStatus();
4513 if ( $this->mBlock
&& $this->mBlock
->appliesToRight( 'createaccount' ) ) {
4514 return $this->mBlock
;
4517 # T15611: if the IP address the user is trying to create an account from is
4518 # blocked with createaccount disabled, prevent new account creation there even
4519 # when the user is logged in
4520 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4521 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4523 return $this->mBlockedFromCreateAccount
instanceof Block
4524 && $this->mBlockedFromCreateAccount
->appliesToRight( 'createaccount' )
4525 ?
$this->mBlockedFromCreateAccount
4530 * Get whether the user is blocked from using Special:Emailuser.
4533 public function isBlockedFromEmailuser() {
4534 $this->getBlockedStatus();
4535 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'sendemail' );
4539 * Get whether the user is blocked from using Special:Upload
4544 public function isBlockedFromUpload() {
4545 $this->getBlockedStatus();
4546 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'upload' );
4550 * Get whether the user is allowed to create an account.
4553 public function isAllowedToCreateAccount() {
4554 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4558 * Get this user's personal page title.
4560 * @return Title User's personal page title
4562 public function getUserPage() {
4563 return Title
::makeTitle( NS_USER
, $this->getName() );
4567 * Get this user's talk page title.
4569 * @return Title User's talk page title
4571 public function getTalkPage() {
4572 $title = $this->getUserPage();
4573 return $title->getTalkPage();
4577 * Determine whether the user is a newbie. Newbies are either
4578 * anonymous IPs, or the most recently created accounts.
4581 public function isNewbie() {
4582 return !$this->isAllowed( 'autoconfirmed' );
4586 * Check to see if the given clear-text password is one of the accepted passwords
4587 * @deprecated since 1.27, use AuthManager instead
4588 * @param string $password User password
4589 * @return bool True if the given password is correct, otherwise False
4591 public function checkPassword( $password ) {
4592 wfDeprecated( __METHOD__
, '1.27' );
4594 $manager = AuthManager
::singleton();
4595 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4596 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4598 'username' => $this->getName(),
4599 'password' => $password,
4602 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4603 switch ( $res->status
) {
4604 case AuthenticationResponse
::PASS
:
4606 case AuthenticationResponse
::FAIL
:
4607 // Hope it's not a PreAuthenticationProvider that failed...
4608 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4609 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4612 throw new BadMethodCallException(
4613 'AuthManager returned a response unsupported by ' . __METHOD__
4619 * Check if the given clear-text password matches the temporary password
4620 * sent by e-mail for password reset operations.
4622 * @deprecated since 1.27, use AuthManager instead
4623 * @param string $plaintext
4624 * @return bool True if matches, false otherwise
4626 public function checkTemporaryPassword( $plaintext ) {
4627 wfDeprecated( __METHOD__
, '1.27' );
4628 // Can't check the temporary password individually.
4629 return $this->checkPassword( $plaintext );
4633 * Initialize (if necessary) and return a session token value
4634 * which can be used in edit forms to show that the user's
4635 * login credentials aren't being hijacked with a foreign form
4639 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4640 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4641 * @return MediaWiki\Session\Token The new edit token
4643 public function getEditTokenObject( $salt = '', $request = null ) {
4644 if ( $this->isAnon() ) {
4645 return new LoggedOutEditToken();
4649 $request = $this->getRequest();
4651 return $request->getSession()->getToken( $salt );
4655 * Initialize (if necessary) and return a session token value
4656 * which can be used in edit forms to show that the user's
4657 * login credentials aren't being hijacked with a foreign form
4660 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4663 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4664 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4665 * @return string The new edit token
4667 public function getEditToken( $salt = '', $request = null ) {
4668 return $this->getEditTokenObject( $salt, $request )->toString();
4672 * Check given value against the token value stored in the session.
4673 * A match should confirm that the form was submitted from the
4674 * user's own login session, not a form submission from a third-party
4677 * @param string $val Input value to compare
4678 * @param string|array $salt Optional function-specific data for hashing
4679 * @param WebRequest|null $request Object to use or null to use $wgRequest
4680 * @param int|null $maxage Fail tokens older than this, in seconds
4681 * @return bool Whether the token matches
4683 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4684 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4688 * Check given value against the token value stored in the session,
4689 * ignoring the suffix.
4691 * @param string $val Input value to compare
4692 * @param string|array $salt Optional function-specific data for hashing
4693 * @param WebRequest|null $request Object to use or null to use $wgRequest
4694 * @param int|null $maxage Fail tokens older than this, in seconds
4695 * @return bool Whether the token matches
4697 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4698 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4699 return $this->matchEditToken( $val, $salt, $request, $maxage );
4703 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4704 * mail to the user's given address.
4706 * @param string $type Message to send, either "created", "changed" or "set"
4709 public function sendConfirmationMail( $type = 'created' ) {
4711 $expiration = null; // gets passed-by-ref and defined in next line.
4712 $token = $this->confirmationToken( $expiration );
4713 $url = $this->confirmationTokenUrl( $token );
4714 $invalidateURL = $this->invalidationTokenUrl( $token );
4715 $this->saveSettings();
4717 if ( $type == 'created' ||
$type === false ) {
4718 $message = 'confirmemail_body';
4720 } elseif ( $type === true ) {
4721 $message = 'confirmemail_body_changed';
4724 // Messages: confirmemail_body_changed, confirmemail_body_set
4725 $message = 'confirmemail_body_' . $type;
4729 'subject' => wfMessage( 'confirmemail_subject' )->text(),
4730 'body' => wfMessage( $message,
4731 $this->getRequest()->getIP(),
4734 $wgLang->userTimeAndDate( $expiration, $this ),
4736 $wgLang->userDate( $expiration, $this ),
4737 $wgLang->userTime( $expiration, $this ) )->text(),
4743 'ip' => $this->getRequest()->getIP(),
4744 'confirmURL' => $url,
4745 'invalidateURL' => $invalidateURL,
4746 'expiration' => $expiration
4749 Hooks
::run( 'UserSendConfirmationMail', [ $this, &$mail, $info ] );
4750 return $this->sendMail( $mail['subject'], $mail['body'], $mail['from'], $mail['replyTo'] );
4754 * Send an e-mail to this user's account. Does not check for
4755 * confirmed status or validity.
4757 * @param string $subject Message subject
4758 * @param string $body Message body
4759 * @param User|null $from Optional sending user; if unspecified, default
4760 * $wgPasswordSender will be used.
4761 * @param MailAddress|null $replyto Reply-To address
4764 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4765 global $wgPasswordSender;
4767 if ( $from instanceof User
) {
4768 $sender = MailAddress
::newFromUser( $from );
4770 $sender = new MailAddress( $wgPasswordSender,
4771 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4773 $to = MailAddress
::newFromUser( $this );
4775 return UserMailer
::send( $to, $sender, $subject, $body, [
4776 'replyTo' => $replyto,
4781 * Generate, store, and return a new e-mail confirmation code.
4782 * A hash (unsalted, since it's used as a key) is stored.
4784 * @note Call saveSettings() after calling this function to commit
4785 * this change to the database.
4787 * @param string &$expiration Accepts the expiration time
4788 * @return string New token
4790 protected function confirmationToken( &$expiration ) {
4791 global $wgUserEmailConfirmationTokenExpiry;
4793 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4794 $expiration = wfTimestamp( TS_MW
, $expires );
4796 $token = MWCryptRand
::generateHex( 32 );
4797 $hash = md5( $token );
4798 $this->mEmailToken
= $hash;
4799 $this->mEmailTokenExpires
= $expiration;
4804 * Return a URL the user can use to confirm their email address.
4805 * @param string $token Accepts the email confirmation token
4806 * @return string New token URL
4808 protected function confirmationTokenUrl( $token ) {
4809 return $this->getTokenUrl( 'ConfirmEmail', $token );
4813 * Return a URL the user can use to invalidate their email address.
4814 * @param string $token Accepts the email confirmation token
4815 * @return string New token URL
4817 protected function invalidationTokenUrl( $token ) {
4818 return $this->getTokenUrl( 'InvalidateEmail', $token );
4822 * Internal function to format the e-mail validation/invalidation URLs.
4823 * This uses a quickie hack to use the
4824 * hardcoded English names of the Special: pages, for ASCII safety.
4826 * @note Since these URLs get dropped directly into emails, using the
4827 * short English names avoids insanely long URL-encoded links, which
4828 * also sometimes can get corrupted in some browsers/mailers
4829 * (T8957 with Gmail and Internet Explorer).
4831 * @param string $page Special page
4832 * @param string $token
4833 * @return string Formatted URL
4835 protected function getTokenUrl( $page, $token ) {
4836 // Hack to bypass localization of 'Special:'
4837 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4838 return $title->getCanonicalURL();
4842 * Mark the e-mail address confirmed.
4844 * @note Call saveSettings() after calling this function to commit the change.
4848 public function confirmEmail() {
4849 // Check if it's already confirmed, so we don't touch the database
4850 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4851 if ( !$this->isEmailConfirmed() ) {
4852 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4853 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4859 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4860 * address if it was already confirmed.
4862 * @note Call saveSettings() after calling this function to commit the change.
4863 * @return bool Returns true
4865 public function invalidateEmail() {
4867 $this->mEmailToken
= null;
4868 $this->mEmailTokenExpires
= null;
4869 $this->setEmailAuthenticationTimestamp( null );
4871 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4876 * Set the e-mail authentication timestamp.
4877 * @param string $timestamp TS_MW timestamp
4879 public function setEmailAuthenticationTimestamp( $timestamp ) {
4881 $this->mEmailAuthenticated
= $timestamp;
4882 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4886 * Is this user allowed to send e-mails within limits of current
4887 * site configuration?
4890 public function canSendEmail() {
4891 global $wgEnableEmail, $wgEnableUserEmail;
4892 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4895 $canSend = $this->isEmailConfirmed();
4896 // Avoid PHP 7.1 warning of passing $this by reference
4898 Hooks
::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
4903 * Is this user allowed to receive e-mails within limits of current
4904 * site configuration?
4907 public function canReceiveEmail() {
4908 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4912 * Is this user's e-mail address valid-looking and confirmed within
4913 * limits of the current site configuration?
4915 * @note If $wgEmailAuthentication is on, this may require the user to have
4916 * confirmed their address by returning a code or using a password
4917 * sent to the address from the wiki.
4921 public function isEmailConfirmed() {
4922 global $wgEmailAuthentication;
4924 // Avoid PHP 7.1 warning of passing $this by reference
4927 if ( Hooks
::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
4928 if ( $this->isAnon() ) {
4931 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4934 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4944 * Check whether there is an outstanding request for e-mail confirmation.
4947 public function isEmailConfirmationPending() {
4948 global $wgEmailAuthentication;
4949 return $wgEmailAuthentication &&
4950 !$this->isEmailConfirmed() &&
4951 $this->mEmailToken
&&
4952 $this->mEmailTokenExpires
> wfTimestamp();
4956 * Get the timestamp of account creation.
4958 * @return string|bool|null Timestamp of account creation, false for
4959 * non-existent/anonymous user accounts, or null if existing account
4960 * but information is not in database.
4962 public function getRegistration() {
4963 if ( $this->isAnon() ) {
4967 return $this->mRegistration
;
4971 * Get the timestamp of the first edit
4973 * @return string|bool Timestamp of first edit, or false for
4974 * non-existent/anonymous user accounts.
4976 public function getFirstEditTimestamp() {
4977 return $this->getEditTimestamp( true );
4981 * Get the timestamp of the latest edit
4984 * @return string|bool Timestamp of first edit, or false for
4985 * non-existent/anonymous user accounts.
4987 public function getLatestEditTimestamp() {
4988 return $this->getEditTimestamp( false );
4992 * Get the timestamp of the first or latest edit
4994 * @param bool $first True for the first edit, false for the latest one
4995 * @return string|bool Timestamp of first or latest edit, or false for
4996 * non-existent/anonymous user accounts.
4998 private function getEditTimestamp( $first ) {
4999 if ( $this->getId() == 0 ) {
5000 return false; // anons
5002 $dbr = wfGetDB( DB_REPLICA
);
5003 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5004 $tsField = isset( $actorWhere['tables']['temp_rev_user'] )
5005 ?
'revactor_timestamp' : 'rev_timestamp';
5006 $sortOrder = $first ?
'ASC' : 'DESC';
5007 $time = $dbr->selectField(
5008 [ 'revision' ] +
$actorWhere['tables'],
5010 [ $actorWhere['conds'] ],
5012 [ 'ORDER BY' => "$tsField $sortOrder" ],
5013 $actorWhere['joins']
5016 return false; // no edits
5018 return wfTimestamp( TS_MW
, $time );
5022 * Get the permissions associated with a given list of groups
5024 * @param array $groups Array of Strings List of internal group names
5025 * @return array Array of Strings List of permission key names for given groups combined
5027 public static function getGroupPermissions( $groups ) {
5028 global $wgGroupPermissions, $wgRevokePermissions;
5030 // grant every granted permission first
5031 foreach ( $groups as $group ) {
5032 if ( isset( $wgGroupPermissions[$group] ) ) {
5033 $rights = array_merge( $rights,
5034 // array_filter removes empty items
5035 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
5038 // now revoke the revoked permissions
5039 foreach ( $groups as $group ) {
5040 if ( isset( $wgRevokePermissions[$group] ) ) {
5041 $rights = array_diff( $rights,
5042 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
5045 return array_unique( $rights );
5049 * Get all the groups who have a given permission
5051 * @param string $role Role to check
5052 * @return array Array of Strings List of internal group names with the given permission
5054 public static function getGroupsWithPermission( $role ) {
5055 global $wgGroupPermissions;
5056 $allowedGroups = [];
5057 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
5058 if ( self
::groupHasPermission( $group, $role ) ) {
5059 $allowedGroups[] = $group;
5062 return $allowedGroups;
5066 * Check, if the given group has the given permission
5068 * If you're wanting to check whether all users have a permission, use
5069 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
5073 * @param string $group Group to check
5074 * @param string $role Role to check
5077 public static function groupHasPermission( $group, $role ) {
5078 global $wgGroupPermissions, $wgRevokePermissions;
5079 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
5080 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
5084 * Check if all users may be assumed to have the given permission
5086 * We generally assume so if the right is granted to '*' and isn't revoked
5087 * on any group. It doesn't attempt to take grants or other extension
5088 * limitations on rights into account in the general case, though, as that
5089 * would require it to always return false and defeat the purpose.
5090 * Specifically, session-based rights restrictions (such as OAuth or bot
5091 * passwords) are applied based on the current session.
5094 * @param string $right Right to check
5097 public static function isEveryoneAllowed( $right ) {
5098 global $wgGroupPermissions, $wgRevokePermissions;
5101 // Use the cached results, except in unit tests which rely on
5102 // being able change the permission mid-request
5103 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
5104 return $cache[$right];
5107 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
5108 $cache[$right] = false;
5112 // If it's revoked anywhere, then everyone doesn't have it
5113 foreach ( $wgRevokePermissions as $rights ) {
5114 if ( isset( $rights[$right] ) && $rights[$right] ) {
5115 $cache[$right] = false;
5120 // Remove any rights that aren't allowed to the global-session user,
5121 // unless there are no sessions for this endpoint.
5122 if ( !defined( 'MW_NO_SESSION' ) ) {
5123 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
5124 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
5125 $cache[$right] = false;
5130 // Allow extensions to say false
5131 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
5132 $cache[$right] = false;
5136 $cache[$right] = true;
5141 * Return the set of defined explicit groups.
5142 * The implicit groups (by default *, 'user' and 'autoconfirmed')
5143 * are not included, as they are defined automatically, not in the database.
5144 * @return array Array of internal group names
5146 public static function getAllGroups() {
5147 global $wgGroupPermissions, $wgRevokePermissions;
5148 return array_values( array_diff(
5149 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
5150 self
::getImplicitGroups()
5155 * Get a list of all available permissions.
5156 * @return string[] Array of permission names
5158 public static function getAllRights() {
5159 if ( self
::$mAllRights === false ) {
5160 global $wgAvailableRights;
5161 if ( count( $wgAvailableRights ) ) {
5162 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
5164 self
::$mAllRights = self
::$mCoreRights;
5166 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
5168 return self
::$mAllRights;
5172 * Get a list of implicit groups
5173 * TODO: Should we deprecate this? It's trivial, but we don't want to encourage use of globals.
5175 * @return array Array of Strings Array of internal group names
5177 public static function getImplicitGroups() {
5178 global $wgImplicitGroups;
5179 return $wgImplicitGroups;
5183 * Get the title of a page describing a particular group
5184 * @deprecated since 1.29 Use UserGroupMembership::getGroupPage instead
5186 * @param string $group Internal group name
5187 * @return Title|bool Title of the page if it exists, false otherwise
5189 public static function getGroupPage( $group ) {
5190 wfDeprecated( __METHOD__
, '1.29' );
5191 return UserGroupMembership
::getGroupPage( $group );
5195 * Create a link to the group in HTML, if available;
5196 * else return the group name.
5197 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5198 * make the link yourself if you need custom text
5200 * @param string $group Internal name of the group
5201 * @param string $text The text of the link
5202 * @return string HTML link to the group
5204 public static function makeGroupLinkHTML( $group, $text = '' ) {
5205 wfDeprecated( __METHOD__
, '1.29' );
5207 if ( $text == '' ) {
5208 $text = UserGroupMembership
::getGroupName( $group );
5210 $title = UserGroupMembership
::getGroupPage( $group );
5212 return MediaWikiServices
::getInstance()
5213 ->getLinkRenderer()->makeLink( $title, $text );
5216 return htmlspecialchars( $text );
5220 * Create a link to the group in Wikitext, if available;
5221 * else return the group name.
5222 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5223 * make the link yourself if you need custom text
5225 * @param string $group Internal name of the group
5226 * @param string $text The text of the link
5227 * @return string Wikilink to the group
5229 public static function makeGroupLinkWiki( $group, $text = '' ) {
5230 wfDeprecated( __METHOD__
, '1.29' );
5232 if ( $text == '' ) {
5233 $text = UserGroupMembership
::getGroupName( $group );
5235 $title = UserGroupMembership
::getGroupPage( $group );
5237 $page = $title->getFullText();
5238 return "[[$page|$text]]";
5245 * Returns an array of the groups that a particular group can add/remove.
5247 * @param string $group The group to check for whether it can add/remove
5248 * @return array Array( 'add' => array( addablegroups ),
5249 * 'remove' => array( removablegroups ),
5250 * 'add-self' => array( addablegroups to self),
5251 * 'remove-self' => array( removable groups from self) )
5253 public static function changeableByGroup( $group ) {
5254 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
5263 if ( empty( $wgAddGroups[$group] ) ) {
5264 // Don't add anything to $groups
5265 } elseif ( $wgAddGroups[$group] === true ) {
5266 // You get everything
5267 $groups['add'] = self
::getAllGroups();
5268 } elseif ( is_array( $wgAddGroups[$group] ) ) {
5269 $groups['add'] = $wgAddGroups[$group];
5272 // Same thing for remove
5273 if ( empty( $wgRemoveGroups[$group] ) ) {
5275 } elseif ( $wgRemoveGroups[$group] === true ) {
5276 $groups['remove'] = self
::getAllGroups();
5277 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
5278 $groups['remove'] = $wgRemoveGroups[$group];
5281 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
5282 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
5283 foreach ( $wgGroupsAddToSelf as $key => $value ) {
5284 if ( is_int( $key ) ) {
5285 $wgGroupsAddToSelf['user'][] = $value;
5290 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
5291 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
5292 if ( is_int( $key ) ) {
5293 $wgGroupsRemoveFromSelf['user'][] = $value;
5298 // Now figure out what groups the user can add to him/herself
5299 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
5301 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
5302 // No idea WHY this would be used, but it's there
5303 $groups['add-self'] = self
::getAllGroups();
5304 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
5305 $groups['add-self'] = $wgGroupsAddToSelf[$group];
5308 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
5310 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
5311 $groups['remove-self'] = self
::getAllGroups();
5312 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
5313 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
5320 * Returns an array of groups that this user can add and remove
5321 * @return array Array( 'add' => array( addablegroups ),
5322 * 'remove' => array( removablegroups ),
5323 * 'add-self' => array( addablegroups to self),
5324 * 'remove-self' => array( removable groups from self) )
5326 public function changeableGroups() {
5327 if ( $this->isAllowed( 'userrights' ) ) {
5328 // This group gives the right to modify everything (reverse-
5329 // compatibility with old "userrights lets you change
5331 // Using array_merge to make the groups reindexed
5332 $all = array_merge( self
::getAllGroups() );
5341 // Okay, it's not so simple, we will have to go through the arrays
5348 $addergroups = $this->getEffectiveGroups();
5350 foreach ( $addergroups as $addergroup ) {
5351 $groups = array_merge_recursive(
5352 $groups, $this->changeableByGroup( $addergroup )
5354 $groups['add'] = array_unique( $groups['add'] );
5355 $groups['remove'] = array_unique( $groups['remove'] );
5356 $groups['add-self'] = array_unique( $groups['add-self'] );
5357 $groups['remove-self'] = array_unique( $groups['remove-self'] );
5363 * Schedule a deferred update to update the user's edit count
5365 public function incEditCount() {
5366 if ( $this->isAnon() ) {
5370 DeferredUpdates
::addUpdate(
5371 new UserEditCountUpdate( $this, 1 ),
5372 DeferredUpdates
::POSTSEND
5377 * This method should not be called outside User/UserEditCountUpdate
5381 public function setEditCountInternal( $count ) {
5382 $this->mEditCount
= $count;
5386 * Initialize user_editcount from data out of the revision table
5388 * This method should not be called outside User/UserEditCountUpdate
5390 * @return int Number of edits
5392 public function initEditCountInternal() {
5393 // Pull from a replica DB to be less cruel to servers
5394 // Accuracy isn't the point anyway here
5395 $dbr = wfGetDB( DB_REPLICA
);
5396 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5397 $count = (int)$dbr->selectField(
5398 [ 'revision' ] +
$actorWhere['tables'],
5400 [ $actorWhere['conds'] ],
5403 $actorWhere['joins']
5406 $dbw = wfGetDB( DB_MASTER
);
5409 [ 'user_editcount' => $count ],
5411 'user_id' => $this->getId(),
5412 'user_editcount IS NULL OR user_editcount < ' . (int)$count
5421 * Get the description of a given right
5424 * @param string $right Right to query
5425 * @return string Localized description of the right
5427 public static function getRightDescription( $right ) {
5428 $key = "right-$right";
5429 $msg = wfMessage( $key );
5430 return $msg->isDisabled() ?
$right : $msg->text();
5434 * Get the name of a given grant
5437 * @param string $grant Grant to query
5438 * @return string Localized name of the grant
5440 public static function getGrantName( $grant ) {
5441 $key = "grant-$grant";
5442 $msg = wfMessage( $key );
5443 return $msg->isDisabled() ?
$grant : $msg->text();
5447 * Add a newuser log entry for this user.
5448 * Before 1.19 the return value was always true.
5450 * @deprecated since 1.27, AuthManager handles logging
5451 * @param string|bool $action Account creation type.
5452 * - String, one of the following values:
5453 * - 'create' for an anonymous user creating an account for himself.
5454 * This will force the action's performer to be the created user itself,
5455 * no matter the value of $wgUser
5456 * - 'create2' for a logged in user creating an account for someone else
5457 * - 'byemail' when the created user will receive its password by e-mail
5458 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5459 * - Boolean means whether the account was created by e-mail (deprecated):
5460 * - true will be converted to 'byemail'
5461 * - false will be converted to 'create' if this object is the same as
5462 * $wgUser and to 'create2' otherwise
5463 * @param string $reason User supplied reason
5466 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5467 return true; // disabled
5471 * Add an autocreate newuser log entry for this user
5472 * Used by things like CentralAuth and perhaps other authplugins.
5473 * Consider calling addNewUserLogEntry() directly instead.
5475 * @deprecated since 1.27, AuthManager handles logging
5478 public function addNewUserLogEntryAutoCreate() {
5479 $this->addNewUserLogEntry( 'autocreate' );
5485 * Load the user options either from cache, the database or an array
5487 * @param array|null $data Rows for the current user out of the user_properties table
5489 protected function loadOptions( $data = null ) {
5492 if ( $this->mOptionsLoaded
) {
5496 $this->mOptions
= self
::getDefaultOptions();
5498 if ( !$this->getId() ) {
5499 // For unlogged-in users, load language/variant options from request.
5500 // There's no need to do it for logged-in users: they can set preferences,
5501 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5502 // so don't override user's choice (especially when the user chooses site default).
5503 $variant = MediaWikiServices
::getInstance()->getContentLanguage()->getDefaultVariant();
5504 $this->mOptions
['variant'] = $variant;
5505 $this->mOptions
['language'] = $variant;
5506 $this->mOptionsLoaded
= true;
5510 // Maybe load from the object
5511 if ( !is_null( $this->mOptionOverrides
) ) {
5512 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5513 foreach ( $this->mOptionOverrides
as $key => $value ) {
5514 $this->mOptions
[$key] = $value;
5517 if ( !is_array( $data ) ) {
5518 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5519 // Load from database
5520 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5521 ?
wfGetDB( DB_MASTER
)
5522 : wfGetDB( DB_REPLICA
);
5524 $res = $dbr->select(
5526 [ 'up_property', 'up_value' ],
5527 [ 'up_user' => $this->getId() ],
5531 $this->mOptionOverrides
= [];
5533 foreach ( $res as $row ) {
5534 // Convert '0' to 0. PHP's boolean conversion considers them both
5535 // false, but e.g. JavaScript considers the former as true.
5536 // @todo: T54542 Somehow determine the desired type (string/int/bool)
5537 // and convert all values here.
5538 if ( $row->up_value
=== '0' ) {
5541 $data[$row->up_property
] = $row->up_value
;
5545 foreach ( $data as $property => $value ) {
5546 $this->mOptionOverrides
[$property] = $value;
5547 $this->mOptions
[$property] = $value;
5551 // Replace deprecated language codes
5552 $this->mOptions
['language'] = LanguageCode
::replaceDeprecatedCodes(
5553 $this->mOptions
['language']
5556 $this->mOptionsLoaded
= true;
5558 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5562 * Saves the non-default options for this user, as previously set e.g. via
5563 * setOption(), in the database's "user_properties" (preferences) table.
5564 * Usually used via saveSettings().
5566 protected function saveOptions() {
5567 $this->loadOptions();
5569 // Not using getOptions(), to keep hidden preferences in database
5570 $saveOptions = $this->mOptions
;
5572 // Allow hooks to abort, for instance to save to a global profile.
5573 // Reset options to default state before saving.
5574 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5578 $userId = $this->getId();
5580 $insert_rows = []; // all the new preference rows
5581 foreach ( $saveOptions as $key => $value ) {
5582 // Don't bother storing default values
5583 $defaultOption = self
::getDefaultOption( $key );
5584 if ( ( $defaultOption === null && $value !== false && $value !== null )
5585 ||
$value != $defaultOption
5588 'up_user' => $userId,
5589 'up_property' => $key,
5590 'up_value' => $value,
5595 $dbw = wfGetDB( DB_MASTER
);
5597 $res = $dbw->select( 'user_properties',
5598 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5600 // Find prior rows that need to be removed or updated. These rows will
5601 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5603 foreach ( $res as $row ) {
5604 if ( !isset( $saveOptions[$row->up_property
] )
5605 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5607 $keysDelete[] = $row->up_property
;
5611 if ( count( $keysDelete ) ) {
5612 // Do the DELETE by PRIMARY KEY for prior rows.
5613 // In the past a very large portion of calls to this function are for setting
5614 // 'rememberpassword' for new accounts (a preference that has since been removed).
5615 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5616 // caused gap locks on [max user ID,+infinity) which caused high contention since
5617 // updates would pile up on each other as they are for higher (newer) user IDs.
5618 // It might not be necessary these days, but it shouldn't hurt either.
5619 $dbw->delete( 'user_properties',
5620 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5622 // Insert the new preference rows
5623 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5627 * Return the list of user fields that should be selected to create
5628 * a new user object.
5629 * @deprecated since 1.31, use self::getQueryInfo() instead.
5632 public static function selectFields() {
5633 wfDeprecated( __METHOD__
, '1.31' );
5641 'user_email_authenticated',
5643 'user_email_token_expires',
5644 'user_registration',
5650 * Return the tables, fields, and join conditions to be selected to create
5651 * a new user object.
5653 * @return array With three keys:
5654 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
5655 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
5656 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
5658 public static function getQueryInfo() {
5659 global $wgActorTableSchemaMigrationStage;
5662 'tables' => [ 'user' ],
5670 'user_email_authenticated',
5672 'user_email_token_expires',
5673 'user_registration',
5679 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
5680 // but it does little harm and might be needed for write callers loading a User.
5681 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
5682 $ret['tables']['user_actor'] = 'actor';
5683 $ret['fields'][] = 'user_actor.actor_id';
5684 $ret['joins']['user_actor'] = [
5685 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) ?
'JOIN' : 'LEFT JOIN',
5686 [ 'user_actor.actor_user = user_id' ]
5694 * Factory function for fatal permission-denied errors
5697 * @param string $permission User right required
5700 static function newFatalPermissionDeniedStatus( $permission ) {
5704 foreach ( self
::getGroupsWithPermission( $permission ) as $group ) {
5705 $groups[] = UserGroupMembership
::getLink( $group, RequestContext
::getMain(), 'wiki' );
5709 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5712 return Status
::newFatal( 'badaccess-group0' );
5716 * Get a new instance of this user that was loaded from the master via a locking read
5718 * Use this instead of the main context User when updating that user. This avoids races
5719 * where that user was loaded from a replica DB or even the master but without proper locks.
5721 * @return User|null Returns null if the user was not found in the DB
5724 public function getInstanceForUpdate() {
5725 if ( !$this->getId() ) {
5726 return null; // anon
5729 $user = self
::newFromId( $this->getId() );
5730 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5738 * Checks if two user objects point to the same user.
5740 * @since 1.25 ; takes a UserIdentity instead of a User since 1.32
5741 * @param UserIdentity $user
5744 public function equals( UserIdentity
$user ) {
5745 // XXX it's not clear whether central ID providers are supposed to obey this
5746 return $this->getName() === $user->getName();