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
;
31 use Wikimedia\ScopedCallback
;
32 use Wikimedia\Rdbms\Database
;
33 use Wikimedia\Rdbms\DBExpectedError
;
34 use Wikimedia\Rdbms\IDatabase
;
37 * The User object encapsulates all of the user-specific settings (user_id,
38 * name, rights, email address, options, last login time). Client
39 * classes use the getXXX() functions to access these fields. These functions
40 * do all the work of determining whether the user is logged in,
41 * whether the requested option can be satisfied from cookies or
42 * whether a database query is needed. Most of the settings needed
43 * for rendering normal pages are set in the cookie to minimize use
46 class User
implements IDBAccessObject
, UserIdentity
{
48 * @const int Number of characters in user_token field.
50 const TOKEN_LENGTH
= 32;
53 * @const string An invalid value for user_token
55 const INVALID_TOKEN
= '*** INVALID ***';
58 * Global constant made accessible as class constants so that autoloader
60 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
62 const EDIT_TOKEN_SUFFIX
= Token
::SUFFIX
;
65 * @const int Serialized record version.
70 * Exclude user options that are set to their default value.
73 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
78 const CHECK_USER_RIGHTS
= true;
83 const IGNORE_USER_RIGHTS
= false;
86 * Array of Strings List of member variables which are saved to the
87 * shared cache (memcached). Any operation which changes the
88 * corresponding database fields must call a cache-clearing function.
91 protected static $mCacheVars = [
99 'mEmailAuthenticated',
101 'mEmailTokenExpires',
106 // user_properties table
113 * Array of Strings Core rights.
114 * Each of these should have a corresponding message of the form
118 protected static $mCoreRights = [
166 'move-categorypages',
167 'move-rootuserpages',
171 'override-export-depth',
193 'userrights-interwiki',
201 * String Cached results of getAllRights()
203 protected static $mAllRights = false;
205 /** Cache variables */
218 /** @var string TS_MW timestamp from the DB */
220 /** @var string TS_MW timestamp from cache */
221 protected $mQuickTouched;
225 public $mEmailAuthenticated;
227 protected $mEmailToken;
229 protected $mEmailTokenExpires;
231 protected $mRegistration;
233 protected $mEditCount;
234 /** @var UserGroupMembership[] Associative array of (group name => UserGroupMembership object) */
235 protected $mGroupMemberships;
237 protected $mOptionOverrides;
241 * Bool Whether the cache variables have been loaded.
244 public $mOptionsLoaded;
247 * Array with already loaded items or true if all items have been loaded.
249 protected $mLoadedItems = [];
253 * String Initialization data source if mLoadedItems!==true. May be one of:
254 * - 'defaults' anonymous user initialised from class defaults
255 * - 'name' initialise from mName
256 * - 'id' initialise from mId
257 * - 'actor' initialise from mActorId
258 * - 'session' log in from session if possible
260 * Use the User::newFrom*() family of functions to set this.
265 * Lazy-initialized variables, invalidated with clearInstanceCache
269 protected $mDatePreference;
277 protected $mBlockreason;
279 protected $mEffectiveGroups;
281 protected $mImplicitGroups;
283 protected $mFormerGroups;
285 protected $mGlobalBlock;
293 /** @var WebRequest */
300 protected $mAllowUsertalk;
303 private $mBlockedFromCreateAccount = false;
305 /** @var int User::READ_* constant bitfield used to load data */
306 protected $queryFlagsUsed = self
::READ_NORMAL
;
308 public static $idCacheByName = [];
311 * Lightweight constructor for an anonymous user.
312 * Use the User::newFrom* factory functions for other kinds of users.
316 * @see newFromActorId()
317 * @see newFromConfirmationCode()
318 * @see newFromSession()
321 public function __construct() {
322 $this->clearInstanceCache( 'defaults' );
328 public function __toString() {
329 return (string)$this->getName();
333 * Test if it's safe to load this User object.
335 * You should typically check this before using $wgUser or
336 * RequestContext::getUser in a method that might be called before the
337 * system has been fully initialized. If the object is unsafe, you should
338 * use an anonymous user:
340 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
346 public function isSafeToLoad() {
347 global $wgFullyInitialised;
349 // The user is safe to load if:
350 // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
351 // * mLoadedItems === true (already loaded)
352 // * mFrom !== 'session' (sessions not involved at all)
354 return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
355 $this->mLoadedItems
=== true ||
$this->mFrom
!== 'session';
359 * Load the user table data for this object from the source given by mFrom.
361 * @param int $flags User::READ_* constant bitfield
363 public function load( $flags = self
::READ_NORMAL
) {
364 global $wgFullyInitialised;
366 if ( $this->mLoadedItems
=== true ) {
370 // Set it now to avoid infinite recursion in accessors
371 $oldLoadedItems = $this->mLoadedItems
;
372 $this->mLoadedItems
= true;
373 $this->queryFlagsUsed
= $flags;
375 // If this is called too early, things are likely to break.
376 if ( !$wgFullyInitialised && $this->mFrom
=== 'session' ) {
377 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
378 ->warning( 'User::loadFromSession called before the end of Setup.php', [
379 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
381 $this->loadDefaults();
382 $this->mLoadedItems
= $oldLoadedItems;
386 switch ( $this->mFrom
) {
388 $this->loadDefaults();
391 // Make sure this thread sees its own changes
392 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
393 if ( $lb->hasOrMadeRecentMasterChanges() ) {
394 $flags |
= self
::READ_LATEST
;
395 $this->queryFlagsUsed
= $flags;
398 $this->mId
= self
::idFromName( $this->mName
, $flags );
400 // Nonexistent user placeholder object
401 $this->loadDefaults( $this->mName
);
403 $this->loadFromId( $flags );
407 // Make sure this thread sees its own changes, if the ID isn't 0
408 if ( $this->mId
!= 0 ) {
409 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
410 if ( $lb->hasOrMadeRecentMasterChanges() ) {
411 $flags |
= self
::READ_LATEST
;
412 $this->queryFlagsUsed
= $flags;
416 $this->loadFromId( $flags );
419 // Make sure this thread sees its own changes
420 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
421 if ( $lb->hasOrMadeRecentMasterChanges() ) {
422 $flags |
= self
::READ_LATEST
;
423 $this->queryFlagsUsed
= $flags;
426 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
427 $row = wfGetDB( $index )->selectRow(
429 [ 'actor_user', 'actor_name' ],
430 [ 'actor_id' => $this->mActorId
],
437 $this->loadDefaults();
438 } elseif ( $row->actor_user
) {
439 $this->mId
= $row->actor_user
;
440 $this->loadFromId( $flags );
442 $this->loadDefaults( $row->actor_name
);
446 if ( !$this->loadFromSession() ) {
447 // Loading from session failed. Load defaults.
448 $this->loadDefaults();
450 Hooks
::run( 'UserLoadAfterLoadFromSession', [ $this ] );
453 throw new UnexpectedValueException(
454 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
459 * Load user table data, given mId has already been set.
460 * @param int $flags User::READ_* constant bitfield
461 * @return bool False if the ID does not exist, true otherwise
463 public function loadFromId( $flags = self
::READ_NORMAL
) {
464 if ( $this->mId
== 0 ) {
465 // Anonymous users are not in the database (don't need cache)
466 $this->loadDefaults();
470 // Try cache (unless this needs data from the master DB).
471 // NOTE: if this thread called saveSettings(), the cache was cleared.
472 $latest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
474 if ( !$this->loadFromDatabase( $flags ) ) {
475 // Can't load from ID
479 $this->loadFromCache();
482 $this->mLoadedItems
= true;
483 $this->queryFlagsUsed
= $flags;
490 * @param string $wikiId
493 public static function purge( $wikiId, $userId ) {
494 $cache = ObjectCache
::getMainWANInstance();
495 $key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
496 $cache->delete( $key );
501 * @param WANObjectCache $cache
504 protected function getCacheKey( WANObjectCache
$cache ) {
505 return $cache->makeGlobalKey( 'user', 'id', wfWikiID(), $this->mId
);
509 * @param WANObjectCache $cache
513 public function getMutableCacheKeys( WANObjectCache
$cache ) {
514 $id = $this->getId();
516 return $id ?
[ $this->getCacheKey( $cache ) ] : [];
520 * Load user data from shared cache, given mId has already been set.
525 protected function loadFromCache() {
526 $cache = ObjectCache
::getMainWANInstance();
527 $data = $cache->getWithSetCallback(
528 $this->getCacheKey( $cache ),
530 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
531 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
532 wfDebug( "User: cache miss for user {$this->mId}\n" );
534 $this->loadFromDatabase( self
::READ_NORMAL
);
536 $this->loadOptions();
539 foreach ( self
::$mCacheVars as $name ) {
540 $data[$name] = $this->$name;
543 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->mTouched
), $ttl );
545 // if a user group membership is about to expire, the cache needs to
546 // expire at that time (T163691)
547 foreach ( $this->mGroupMemberships
as $ugm ) {
548 if ( $ugm->getExpiry() ) {
549 $secondsUntilExpiry = wfTimestamp( TS_UNIX
, $ugm->getExpiry() ) - time();
550 if ( $secondsUntilExpiry > 0 && $secondsUntilExpiry < $ttl ) {
551 $ttl = $secondsUntilExpiry;
558 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'version' => self
::VERSION
]
561 // Restore from cache
562 foreach ( self
::$mCacheVars as $name ) {
563 $this->$name = $data[$name];
569 /** @name newFrom*() static factory methods */
573 * Static factory method for creation from username.
575 * This is slightly less efficient than newFromId(), so use newFromId() if
576 * you have both an ID and a name handy.
578 * @param string $name Username, validated by Title::newFromText()
579 * @param string|bool $validate Validate username. Takes the same parameters as
580 * User::getCanonicalName(), except that true is accepted as an alias
581 * for 'valid', for BC.
583 * @return User|bool User object, or false if the username is invalid
584 * (e.g. if it contains illegal characters or is an IP address). If the
585 * username is not present in the database, the result will be a user object
586 * with a name, zero user ID and default settings.
588 public static function newFromName( $name, $validate = 'valid' ) {
589 if ( $validate === true ) {
592 $name = self
::getCanonicalName( $name, $validate );
593 if ( $name === false ) {
596 // Create unloaded user object
600 $u->setItemLoaded( 'name' );
606 * Static factory method for creation from a given user ID.
608 * @param int $id Valid user ID
609 * @return User The corresponding User object
611 public static function newFromId( $id ) {
615 $u->setItemLoaded( 'id' );
620 * Static factory method for creation from a given actor ID.
623 * @param int $id Valid actor ID
624 * @return User The corresponding User object
626 public static function newFromActorId( $id ) {
627 global $wgActorTableSchemaMigrationStage;
629 if ( $wgActorTableSchemaMigrationStage <= MIGRATION_OLD
) {
630 throw new BadMethodCallException(
631 'Cannot use ' . __METHOD__
. ' when $wgActorTableSchemaMigrationStage is MIGRATION_OLD'
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 if ( $wgActorTableSchemaMigrationStage > MIGRATION_OLD
&& $actorId !== null ) {
682 $user->mActorId
= (int)$actorId;
683 if ( $user->mActorId
!== 0 ) {
684 $user->mFrom
= 'actor';
686 $user->setItemLoaded( 'actor' );
689 if ( $userName !== null && $userName !== '' ) {
690 $user->mName
= $userName;
691 $user->mFrom
= 'name';
692 $user->setItemLoaded( 'name' );
695 if ( $userId !== null ) {
696 $user->mId
= (int)$userId;
697 if ( $user->mId
!== 0 ) {
700 $user->setItemLoaded( 'id' );
703 if ( $user->mFrom
=== 'defaults' ) {
704 throw new InvalidArgumentException(
705 'Cannot create a user with no name, no ID, and no actor ID'
713 * Factory method to fetch whichever user has a given email confirmation code.
714 * This code is generated when an account is created or its e-mail address
717 * If the code is invalid or has expired, returns NULL.
719 * @param string $code Confirmation code
720 * @param int $flags User::READ_* bitfield
723 public static function newFromConfirmationCode( $code, $flags = 0 ) {
724 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
725 ?
wfGetDB( DB_MASTER
)
726 : wfGetDB( DB_REPLICA
);
728 $id = $db->selectField(
732 'user_email_token' => md5( $code ),
733 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
737 return $id ? self
::newFromId( $id ) : null;
741 * Create a new user object using data from session. If the login
742 * credentials are invalid, the result is an anonymous user.
744 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
747 public static function newFromSession( WebRequest
$request = null ) {
749 $user->mFrom
= 'session';
750 $user->mRequest
= $request;
755 * Create a new user object from a user row.
756 * The row should have the following fields from the user table in it:
757 * - either user_name or user_id to load further data if needed (or both)
759 * - all other fields (email, etc.)
760 * It is useless to provide the remaining fields if either user_id,
761 * user_name and user_real_name are not provided because the whole row
762 * will be loaded once more from the database when accessing them.
764 * @param stdClass $row A row from the user table
765 * @param array|null $data Further data to load into the object
766 * (see User::loadFromRow for valid keys)
769 public static function newFromRow( $row, $data = null ) {
771 $user->loadFromRow( $row, $data );
776 * Static factory method for creation of a "system" user from username.
778 * A "system" user is an account that's used to attribute logged actions
779 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
780 * might include the 'Maintenance script' or 'Conversion script' accounts
781 * used by various scripts in the maintenance/ directory or accounts such
782 * as 'MediaWiki message delivery' used by the MassMessage extension.
784 * This can optionally create the user if it doesn't exist, and "steal" the
785 * account if it does exist.
787 * "Stealing" an existing user is intended to make it impossible for normal
788 * authentication processes to use the account, effectively disabling the
789 * account for normal use:
790 * - Email is invalidated, to prevent account recovery by emailing a
791 * temporary password and to disassociate the account from the existing
793 * - The token is set to a magic invalid value, to kill existing sessions
794 * and to prevent $this->setToken() calls from resetting the token to a
796 * - SessionManager is instructed to prevent new sessions for the user, to
797 * do things like deauthorizing OAuth consumers.
798 * - AuthManager is instructed to revoke access, to invalidate or remove
799 * passwords and other credentials.
801 * @param string $name Username
802 * @param array $options Options are:
803 * - validate: As for User::getCanonicalName(), default 'valid'
804 * - create: Whether to create the user if it doesn't already exist, default true
805 * - steal: Whether to "disable" the account for normal use if it already
806 * exists, default false
810 public static function newSystemUser( $name, $options = [] ) {
812 'validate' => 'valid',
817 $name = self
::getCanonicalName( $name, $options['validate'] );
818 if ( $name === false ) {
822 $dbr = wfGetDB( DB_REPLICA
);
823 $userQuery = self
::getQueryInfo();
824 $row = $dbr->selectRow(
825 $userQuery['tables'],
826 $userQuery['fields'],
827 [ 'user_name' => $name ],
833 // Try the master database...
834 $dbw = wfGetDB( DB_MASTER
);
835 $row = $dbw->selectRow(
836 $userQuery['tables'],
837 $userQuery['fields'],
838 [ 'user_name' => $name ],
846 // No user. Create it?
847 return $options['create']
848 ? self
::createNew( $name, [ 'token' => self
::INVALID_TOKEN
] )
852 $user = self
::newFromRow( $row );
854 // A user is considered to exist as a non-system user if it can
855 // authenticate, or has an email set, or has a non-invalid token.
856 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
857 AuthManager
::singleton()->userCanAuthenticate( $name )
859 // User exists. Steal it?
860 if ( !$options['steal'] ) {
864 AuthManager
::singleton()->revokeAccessForUser( $name );
866 $user->invalidateEmail();
867 $user->mToken
= self
::INVALID_TOKEN
;
868 $user->saveSettings();
869 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
878 * Get the username corresponding to a given user ID
879 * @param int $id User ID
880 * @return string|bool The corresponding username
882 public static function whoIs( $id ) {
883 return UserCache
::singleton()->getProp( $id, 'name' );
887 * Get the real name of a user given their user ID
889 * @param int $id User ID
890 * @return string|bool The corresponding user's real name
892 public static function whoIsReal( $id ) {
893 return UserCache
::singleton()->getProp( $id, 'real_name' );
897 * Get database id given a user name
898 * @param string $name Username
899 * @param int $flags User::READ_* constant bitfield
900 * @return int|null The corresponding user's ID, or null if user is nonexistent
902 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
903 $nt = Title
::makeTitleSafe( NS_USER
, $name );
904 if ( is_null( $nt ) ) {
909 if ( !( $flags & self
::READ_LATEST
) && array_key_exists( $name, self
::$idCacheByName ) ) {
910 return self
::$idCacheByName[$name];
913 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
914 $db = wfGetDB( $index );
919 [ 'user_name' => $nt->getText() ],
924 if ( $s === false ) {
927 $result = $s->user_id
;
930 self
::$idCacheByName[$name] = $result;
932 if ( count( self
::$idCacheByName ) > 1000 ) {
933 self
::$idCacheByName = [];
940 * Reset the cache used in idFromName(). For use in tests.
942 public static function resetIdByNameCache() {
943 self
::$idCacheByName = [];
947 * Does the string match an anonymous IP address?
949 * This function exists for username validation, in order to reject
950 * usernames which are similar in form to IP addresses. Strings such
951 * as 300.300.300.300 will return true because it looks like an IP
952 * address, despite not being strictly valid.
954 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
955 * address because the usemod software would "cloak" anonymous IP
956 * addresses like this, if we allowed accounts like this to be created
957 * new users could get the old edits of these anonymous users.
959 * @param string $name Name to match
962 public static function isIP( $name ) {
963 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
964 || IP
::isIPv6( $name );
968 * Is the user an IP range?
973 public function isIPRange() {
974 return IP
::isValidRange( $this->mName
);
978 * Is the input a valid username?
980 * Checks if the input is a valid username, we don't want an empty string,
981 * an IP address, anything that contains slashes (would mess up subpages),
982 * is longer than the maximum allowed username size or doesn't begin with
985 * @param string $name Name to match
988 public static function isValidUserName( $name ) {
989 global $wgMaxNameChars;
992 || self
::isIP( $name )
993 ||
strpos( $name, '/' ) !== false
994 ||
strlen( $name ) > $wgMaxNameChars
995 ||
$name != MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name )
1000 // Ensure that the name can't be misresolved as a different title,
1001 // such as with extra namespace keys at the start.
1002 $parsed = Title
::newFromText( $name );
1003 if ( is_null( $parsed )
1004 ||
$parsed->getNamespace()
1005 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
1009 // Check an additional blacklist of troublemaker characters.
1010 // Should these be merged into the title char list?
1011 $unicodeBlacklist = '/[' .
1012 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
1013 '\x{00a0}' . # non-breaking space
1014 '\x{2000}-\x{200f}' . # various whitespace
1015 '\x{2028}-\x{202f}' . # breaks and control chars
1016 '\x{3000}' . # ideographic space
1017 '\x{e000}-\x{f8ff}' . # private use
1019 if ( preg_match( $unicodeBlacklist, $name ) ) {
1027 * Usernames which fail to pass this function will be blocked
1028 * from user login and new account registrations, but may be used
1029 * internally by batch processes.
1031 * If an account already exists in this form, login will be blocked
1032 * by a failure to pass this function.
1034 * @param string $name Name to match
1037 public static function isUsableName( $name ) {
1038 global $wgReservedUsernames;
1039 // Must be a valid username, obviously ;)
1040 if ( !self
::isValidUserName( $name ) ) {
1044 static $reservedUsernames = false;
1045 if ( !$reservedUsernames ) {
1046 $reservedUsernames = $wgReservedUsernames;
1047 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
1050 // Certain names may be reserved for batch processes.
1051 foreach ( $reservedUsernames as $reserved ) {
1052 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
1053 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
1055 if ( $reserved == $name ) {
1063 * Return the users who are members of the given group(s). In case of multiple groups,
1064 * users who are members of at least one of them are returned.
1066 * @param string|array $groups A single group name or an array of group names
1067 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
1068 * records; larger values are ignored.
1069 * @param int|null $after ID the user to start after
1070 * @return UserArrayFromResult
1072 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
1073 if ( $groups === [] ) {
1074 return UserArrayFromResult
::newFromIDs( [] );
1077 $groups = array_unique( (array)$groups );
1078 $limit = min( 5000, $limit );
1080 $conds = [ 'ug_group' => $groups ];
1081 if ( $after !== null ) {
1082 $conds[] = 'ug_user > ' . (int)$after;
1085 $dbr = wfGetDB( DB_REPLICA
);
1086 $ids = $dbr->selectFieldValues(
1093 'ORDER BY' => 'ug_user',
1097 return UserArray
::newFromIDs( $ids );
1101 * Usernames which fail to pass this function will be blocked
1102 * from new account registrations, but may be used internally
1103 * either by batch processes or by user accounts which have
1104 * already been created.
1106 * Additional blacklisting may be added here rather than in
1107 * isValidUserName() to avoid disrupting existing accounts.
1109 * @param string $name String to match
1112 public static function isCreatableName( $name ) {
1113 global $wgInvalidUsernameCharacters;
1115 // Ensure that the username isn't longer than 235 bytes, so that
1116 // (at least for the builtin skins) user javascript and css files
1117 // will work. (T25080)
1118 if ( strlen( $name ) > 235 ) {
1119 wfDebugLog( 'username', __METHOD__
.
1120 ": '$name' invalid due to length" );
1124 // Preg yells if you try to give it an empty string
1125 if ( $wgInvalidUsernameCharacters !== '' ) {
1126 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
1127 wfDebugLog( 'username', __METHOD__
.
1128 ": '$name' invalid due to wgInvalidUsernameCharacters" );
1133 return self
::isUsableName( $name );
1137 * Is the input a valid password for this user?
1139 * @param string $password Desired password
1142 public function isValidPassword( $password ) {
1143 // simple boolean wrapper for getPasswordValidity
1144 return $this->getPasswordValidity( $password ) === true;
1148 * Given unvalidated password input, return error message on failure.
1150 * @param string $password Desired password
1151 * @return bool|string|array True on success, string or array of error message on failure
1153 public function getPasswordValidity( $password ) {
1154 $result = $this->checkPasswordValidity( $password );
1155 if ( $result->isGood() ) {
1159 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
1160 $messages[] = $error['message'];
1162 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
1163 $messages[] = $warning['message'];
1165 if ( count( $messages ) === 1 ) {
1166 return $messages[0];
1173 * Check if this is a valid password for this user
1175 * Create a Status object based on the password's validity.
1176 * The Status should be set to fatal if the user should not
1177 * be allowed to log in, and should have any errors that
1178 * would block changing the password.
1180 * If the return value of this is not OK, the password
1181 * should not be checked. If the return value is not Good,
1182 * the password can be checked, but the user should not be
1183 * able to set their password to this.
1185 * @param string $password Desired password
1189 public function checkPasswordValidity( $password ) {
1190 global $wgPasswordPolicy;
1192 $upp = new UserPasswordPolicy(
1193 $wgPasswordPolicy['policies'],
1194 $wgPasswordPolicy['checks']
1197 $status = Status
::newGood();
1198 $result = false; // init $result to false for the internal checks
1200 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1201 $status->error( $result );
1205 if ( $result === false ) {
1206 $status->merge( $upp->checkUserPassword( $this, $password ) );
1208 } elseif ( $result === true ) {
1211 $status->error( $result );
1212 return $status; // the isValidPassword hook set a string $result and returned true
1217 * Given unvalidated user input, return a canonical username, or false if
1218 * the username is invalid.
1219 * @param string $name User input
1220 * @param string|bool $validate Type of validation to use:
1221 * - false No validation
1222 * - 'valid' Valid for batch processes
1223 * - 'usable' Valid for batch processes and login
1224 * - 'creatable' Valid for batch processes, login and account creation
1226 * @throws InvalidArgumentException
1227 * @return bool|string
1229 public static function getCanonicalName( $name, $validate = 'valid' ) {
1230 // Force usernames to capital
1231 $name = MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name );
1233 # Reject names containing '#'; these will be cleaned up
1234 # with title normalisation, but then it's too late to
1236 if ( strpos( $name, '#' ) !== false ) {
1240 // Clean up name according to title rules,
1241 // but only when validation is requested (T14654)
1242 $t = ( $validate !== false ) ?
1243 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1244 // Check for invalid titles
1245 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1249 // Reject various classes of invalid names
1250 $name = AuthManager
::callLegacyAuthPlugin(
1251 'getCanonicalName', [ $t->getText() ], $t->getText()
1254 switch ( $validate ) {
1258 if ( !self
::isValidUserName( $name ) ) {
1263 if ( !self
::isUsableName( $name ) ) {
1268 if ( !self
::isCreatableName( $name ) ) {
1273 throw new InvalidArgumentException(
1274 'Invalid parameter value for $validate in ' . __METHOD__
);
1280 * Return a random password.
1282 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1283 * @return string New random password
1285 public static function randomPassword() {
1286 global $wgMinimalPasswordLength;
1287 return PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1291 * Set cached properties to default.
1293 * @note This no longer clears uncached lazy-initialised properties;
1294 * the constructor does that instead.
1296 * @param string|bool $name
1298 public function loadDefaults( $name = false ) {
1300 $this->mName
= $name;
1301 $this->mActorId
= null;
1302 $this->mRealName
= '';
1304 $this->mOptionOverrides
= null;
1305 $this->mOptionsLoaded
= false;
1307 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1308 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1309 if ( $loggedOut !== 0 ) {
1310 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1312 $this->mTouched
= '1'; # Allow any pages to be cached
1315 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1316 $this->mEmailAuthenticated
= null;
1317 $this->mEmailToken
= '';
1318 $this->mEmailTokenExpires
= null;
1319 $this->mRegistration
= wfTimestamp( TS_MW
);
1320 $this->mGroupMemberships
= [];
1322 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1326 * Return whether an item has been loaded.
1328 * @param string $item Item to check. Current possibilities:
1332 * @param string $all 'all' to check if the whole object has been loaded
1333 * or any other string to check if only the item is available (e.g.
1337 public function isItemLoaded( $item, $all = 'all' ) {
1338 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1339 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1343 * Set that an item has been loaded
1345 * @param string $item
1347 protected function setItemLoaded( $item ) {
1348 if ( is_array( $this->mLoadedItems
) ) {
1349 $this->mLoadedItems
[$item] = true;
1354 * Load user data from the session.
1356 * @return bool True if the user is logged in, false otherwise.
1358 private function loadFromSession() {
1361 Hooks
::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1362 if ( $result !== null ) {
1366 // MediaWiki\Session\Session already did the necessary authentication of the user
1367 // returned here, so just use it if applicable.
1368 $session = $this->getRequest()->getSession();
1369 $user = $session->getUser();
1370 if ( $user->isLoggedIn() ) {
1371 $this->loadFromUserObject( $user );
1372 if ( $user->isBlocked() ) {
1373 // If this user is autoblocked, set a cookie to track the Block. This has to be done on
1374 // every session load, because an autoblocked editor might not edit again from the same
1375 // IP address after being blocked.
1376 $this->trackBlockWithCookie();
1379 // Other code expects these to be set in the session, so set them.
1380 $session->set( 'wsUserID', $this->getId() );
1381 $session->set( 'wsUserName', $this->getName() );
1382 $session->set( 'wsToken', $this->getToken() );
1391 * Set the 'BlockID' cookie depending on block type and user authentication status.
1393 public function trackBlockWithCookie() {
1394 $block = $this->getBlock();
1395 if ( $block && $this->getRequest()->getCookie( 'BlockID' ) === null ) {
1396 $config = RequestContext
::getMain()->getConfig();
1397 $shouldSetCookie = false;
1399 if ( $this->isAnon() && $config->get( 'CookieSetOnIpBlock' ) ) {
1400 // If user is logged-out, set a cookie to track the Block
1401 $shouldSetCookie = in_array( $block->getType(), [
1402 Block
::TYPE_IP
, Block
::TYPE_RANGE
1404 if ( $shouldSetCookie ) {
1405 $block->setCookie( $this->getRequest()->response() );
1407 // temporary measure the use of cookies on ip blocks
1408 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1409 $stats->increment( 'block.ipblock.setCookie.success' );
1411 } elseif ( $this->isLoggedIn() && $config->get( 'CookieSetOnAutoblock' ) ) {
1412 $shouldSetCookie = $block->getType() === Block
::TYPE_USER
&& $block->isAutoblocking();
1413 if ( $shouldSetCookie ) {
1414 $block->setCookie( $this->getRequest()->response() );
1421 * Load user and user_group data from the database.
1422 * $this->mId must be set, this is how the user is identified.
1424 * @param int $flags User::READ_* constant bitfield
1425 * @return bool True if the user exists, false if the user is anonymous
1427 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1429 $this->mId
= intval( $this->mId
);
1431 if ( !$this->mId
) {
1432 // Anonymous users are not in the database
1433 $this->loadDefaults();
1437 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1438 $db = wfGetDB( $index );
1440 $userQuery = self
::getQueryInfo();
1441 $s = $db->selectRow(
1442 $userQuery['tables'],
1443 $userQuery['fields'],
1444 [ 'user_id' => $this->mId
],
1450 $this->queryFlagsUsed
= $flags;
1451 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1453 if ( $s !== false ) {
1454 // Initialise user table data
1455 $this->loadFromRow( $s );
1456 $this->mGroupMemberships
= null; // deferred
1457 $this->getEditCount(); // revalidation for nulls
1462 $this->loadDefaults();
1468 * Initialize this object from a row from the user table.
1470 * @param stdClass $row Row from the user table to load.
1471 * @param array|null $data Further user data to load into the object
1473 * user_groups Array of arrays or stdClass result rows out of the user_groups
1474 * table. Previously you were supposed to pass an array of strings
1475 * here, but we also need expiry info nowadays, so an array of
1476 * strings is ignored.
1477 * user_properties Array with properties out of the user_properties table
1479 protected function loadFromRow( $row, $data = null ) {
1480 global $wgActorTableSchemaMigrationStage;
1482 if ( !is_object( $row ) ) {
1483 throw new InvalidArgumentException( '$row must be an object' );
1488 $this->mGroupMemberships
= null; // deferred
1490 if ( $wgActorTableSchemaMigrationStage > MIGRATION_OLD
) {
1491 if ( isset( $row->actor_id
) ) {
1492 $this->mActorId
= (int)$row->actor_id
;
1493 if ( $this->mActorId
!== 0 ) {
1494 $this->mFrom
= 'actor';
1496 $this->setItemLoaded( 'actor' );
1502 if ( isset( $row->user_name
) && $row->user_name
!== '' ) {
1503 $this->mName
= $row->user_name
;
1504 $this->mFrom
= 'name';
1505 $this->setItemLoaded( 'name' );
1510 if ( isset( $row->user_real_name
) ) {
1511 $this->mRealName
= $row->user_real_name
;
1512 $this->setItemLoaded( 'realname' );
1517 if ( isset( $row->user_id
) ) {
1518 $this->mId
= intval( $row->user_id
);
1519 if ( $this->mId
!== 0 ) {
1520 $this->mFrom
= 'id';
1522 $this->setItemLoaded( 'id' );
1527 if ( isset( $row->user_id
) && isset( $row->user_name
) && $row->user_name
!== '' ) {
1528 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1531 if ( isset( $row->user_editcount
) ) {
1532 $this->mEditCount
= $row->user_editcount
;
1537 if ( isset( $row->user_touched
) ) {
1538 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1543 if ( isset( $row->user_token
) ) {
1544 // The definition for the column is binary(32), so trim the NULs
1545 // that appends. The previous definition was char(32), so trim
1547 $this->mToken
= rtrim( $row->user_token
, " \0" );
1548 if ( $this->mToken
=== '' ) {
1549 $this->mToken
= null;
1555 if ( isset( $row->user_email
) ) {
1556 $this->mEmail
= $row->user_email
;
1557 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1558 $this->mEmailToken
= $row->user_email_token
;
1559 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1560 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1566 $this->mLoadedItems
= true;
1569 if ( is_array( $data ) ) {
1570 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1571 if ( !count( $data['user_groups'] ) ) {
1572 $this->mGroupMemberships
= [];
1574 $firstGroup = reset( $data['user_groups'] );
1575 if ( is_array( $firstGroup ) ||
is_object( $firstGroup ) ) {
1576 $this->mGroupMemberships
= [];
1577 foreach ( $data['user_groups'] as $row ) {
1578 $ugm = UserGroupMembership
::newFromRow( (object)$row );
1579 $this->mGroupMemberships
[$ugm->getGroup()] = $ugm;
1584 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1585 $this->loadOptions( $data['user_properties'] );
1591 * Load the data for this user object from another user object.
1595 protected function loadFromUserObject( $user ) {
1597 foreach ( self
::$mCacheVars as $var ) {
1598 $this->$var = $user->$var;
1603 * Load the groups from the database if they aren't already loaded.
1605 private function loadGroups() {
1606 if ( is_null( $this->mGroupMemberships
) ) {
1607 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1608 ?
wfGetDB( DB_MASTER
)
1609 : wfGetDB( DB_REPLICA
);
1610 $this->mGroupMemberships
= UserGroupMembership
::getMembershipsForUser(
1616 * Add the user to the group if he/she meets given criteria.
1618 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1619 * possible to remove manually via Special:UserRights. In such case it
1620 * will not be re-added automatically. The user will also not lose the
1621 * group if they no longer meet the criteria.
1623 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1625 * @return array Array of groups the user has been promoted to.
1627 * @see $wgAutopromoteOnce
1629 public function addAutopromoteOnceGroups( $event ) {
1630 global $wgAutopromoteOnceLogInRC;
1632 if ( wfReadOnly() ||
!$this->getId() ) {
1636 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1637 if ( !count( $toPromote ) ) {
1641 if ( !$this->checkAndSetTouched() ) {
1642 return []; // raced out (bug T48834)
1645 $oldGroups = $this->getGroups(); // previous groups
1646 $oldUGMs = $this->getGroupMemberships();
1647 foreach ( $toPromote as $group ) {
1648 $this->addGroup( $group );
1650 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1651 $newUGMs = $this->getGroupMemberships();
1653 // update groups in external authentication database
1654 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );
1655 AuthManager
::callLegacyAuthPlugin( 'updateExternalDBGroups', [ $this, $toPromote ] );
1657 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1658 $logEntry->setPerformer( $this );
1659 $logEntry->setTarget( $this->getUserPage() );
1660 $logEntry->setParameters( [
1661 '4::oldgroups' => $oldGroups,
1662 '5::newgroups' => $newGroups,
1664 $logid = $logEntry->insert();
1665 if ( $wgAutopromoteOnceLogInRC ) {
1666 $logEntry->publish( $logid );
1673 * Builds update conditions. Additional conditions may be added to $conditions to
1674 * protected against race conditions using a compare-and-set (CAS) mechanism
1675 * based on comparing $this->mTouched with the user_touched field.
1677 * @param Database $db
1678 * @param array $conditions WHERE conditions for use with Database::update
1679 * @return array WHERE conditions for use with Database::update
1681 protected function makeUpdateConditions( Database
$db, array $conditions ) {
1682 if ( $this->mTouched
) {
1683 // CAS check: only update if the row wasn't changed sicne it was loaded.
1684 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1691 * Bump user_touched if it didn't change since this object was loaded
1693 * On success, the mTouched field is updated.
1694 * The user serialization cache is always cleared.
1696 * @return bool Whether user_touched was actually updated
1699 protected function checkAndSetTouched() {
1702 if ( !$this->mId
) {
1703 return false; // anon
1706 // Get a new user_touched that is higher than the old one
1707 $newTouched = $this->newTouchedTimestamp();
1709 $dbw = wfGetDB( DB_MASTER
);
1710 $dbw->update( 'user',
1711 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1712 $this->makeUpdateConditions( $dbw, [
1713 'user_id' => $this->mId
,
1717 $success = ( $dbw->affectedRows() > 0 );
1720 $this->mTouched
= $newTouched;
1721 $this->clearSharedCache();
1723 // Clears on failure too since that is desired if the cache is stale
1724 $this->clearSharedCache( 'refresh' );
1731 * Clear various cached data stored in this object. The cache of the user table
1732 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1734 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1735 * given source. May be "name", "id", "actor", "defaults", "session", or false for no reload.
1737 public function clearInstanceCache( $reloadFrom = false ) {
1738 $this->mNewtalk
= -1;
1739 $this->mDatePreference
= null;
1740 $this->mBlockedby
= -1; # Unset
1741 $this->mHash
= false;
1742 $this->mRights
= null;
1743 $this->mEffectiveGroups
= null;
1744 $this->mImplicitGroups
= null;
1745 $this->mGroupMemberships
= null;
1746 $this->mOptions
= null;
1747 $this->mOptionsLoaded
= false;
1748 $this->mEditCount
= null;
1750 if ( $reloadFrom ) {
1751 $this->mLoadedItems
= [];
1752 $this->mFrom
= $reloadFrom;
1757 * Combine the language default options with any site-specific options
1758 * and add the default language variants.
1760 * @return array Array of String options
1762 public static function getDefaultOptions() {
1763 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgDefaultSkin;
1765 static $defOpt = null;
1766 static $defOptLang = null;
1768 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
1769 if ( $defOpt !== null && $defOptLang === $contLang->getCode() ) {
1770 // The content language does not change (and should not change) mid-request, but the
1771 // unit tests change it anyway, and expect this method to return values relevant to the
1772 // current content language.
1776 $defOpt = $wgDefaultUserOptions;
1777 // Default language setting
1778 $defOptLang = $contLang->getCode();
1779 $defOpt['language'] = $defOptLang;
1780 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1781 if ( $langCode === $contLang->getCode() ) {
1782 $defOpt['variant'] = $langCode;
1784 $defOpt["variant-$langCode"] = $langCode;
1788 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1789 // since extensions may change the set of searchable namespaces depending
1790 // on user groups/permissions.
1791 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1792 $defOpt['searchNs' . $nsnum] = (bool)$val;
1794 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1796 Hooks
::run( 'UserGetDefaultOptions', [ &$defOpt ] );
1802 * Get a given default option value.
1804 * @param string $opt Name of option to retrieve
1805 * @return string Default option value
1807 public static function getDefaultOption( $opt ) {
1808 $defOpts = self
::getDefaultOptions();
1809 if ( isset( $defOpts[$opt] ) ) {
1810 return $defOpts[$opt];
1817 * Get blocking information
1818 * @param bool $bFromSlave Whether to check the replica DB first.
1819 * To improve performance, non-critical checks are done against replica DBs.
1820 * Check when actually saving should be done against master.
1822 private function getBlockedStatus( $bFromSlave = true ) {
1823 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff, $wgSoftBlockRanges;
1825 if ( -1 != $this->mBlockedby
) {
1829 wfDebug( __METHOD__
. ": checking...\n" );
1831 // Initialize data...
1832 // Otherwise something ends up stomping on $this->mBlockedby when
1833 // things get lazy-loaded later, causing false positive block hits
1834 // due to -1 !== 0. Probably session-related... Nothing should be
1835 // overwriting mBlockedby, surely?
1838 # We only need to worry about passing the IP address to the Block generator if the
1839 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1840 # know which IP address they're actually coming from
1842 if ( !$this->isAllowed( 'ipblock-exempt' ) ) {
1843 // $wgUser->getName() only works after the end of Setup.php. Until
1844 // then, assume it's a logged-out user.
1845 $globalUserName = $wgUser->isSafeToLoad()
1846 ?
$wgUser->getName()
1847 : IP
::sanitizeIP( $wgUser->getRequest()->getIP() );
1848 if ( $this->getName() === $globalUserName ) {
1849 $ip = $this->getRequest()->getIP();
1854 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1857 if ( !$block instanceof Block
) {
1858 $block = $this->getBlockFromCookieValue( $this->getRequest()->getCookie( 'BlockID' ) );
1862 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1864 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1865 $block = new Block( [
1866 'byText' => wfMessage( 'proxyblocker' )->text(),
1867 'reason' => wfMessage( 'proxyblockreason' )->plain(),
1869 'systemBlock' => 'proxy',
1871 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1872 $block = new Block( [
1873 'byText' => wfMessage( 'sorbs' )->text(),
1874 'reason' => wfMessage( 'sorbsreason' )->plain(),
1876 'systemBlock' => 'dnsbl',
1881 // (T25343) Apply IP blocks to the contents of XFF headers, if enabled
1882 if ( !$block instanceof Block
1883 && $wgApplyIpBlocksToXff
1885 && !in_array( $ip, $wgProxyWhitelist )
1887 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1888 $xff = array_map( 'trim', explode( ',', $xff ) );
1889 $xff = array_diff( $xff, [ $ip ] );
1890 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1891 $block = Block
::chooseBlock( $xffblocks, $xff );
1892 if ( $block instanceof Block
) {
1893 # Mangle the reason to alert the user that the block
1894 # originated from matching the X-Forwarded-For header.
1895 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->plain();
1899 if ( !$block instanceof Block
1902 && IP
::isInRanges( $ip, $wgSoftBlockRanges )
1904 $block = new Block( [
1906 'byText' => 'MediaWiki default',
1907 'reason' => wfMessage( 'softblockrangesreason', $ip )->plain(),
1909 'systemBlock' => 'wgSoftBlockRanges',
1913 if ( $block instanceof Block
) {
1914 wfDebug( __METHOD__
. ": Found block.\n" );
1915 $this->mBlock
= $block;
1916 $this->mBlockedby
= $block->getByName();
1917 $this->mBlockreason
= $block->mReason
;
1918 $this->mHideName
= $block->mHideName
;
1919 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1921 $this->mBlock
= null;
1922 $this->mBlockedby
= '';
1923 $this->mBlockreason
= '';
1924 $this->mHideName
= 0;
1925 $this->mAllowUsertalk
= false;
1928 // Avoid PHP 7.1 warning of passing $this by reference
1931 Hooks
::run( 'GetBlockedStatus', [ &$user ] );
1935 * Try to load a Block from an ID given in a cookie value.
1936 * @param string|null $blockCookieVal The cookie value to check.
1937 * @return Block|bool The Block object, or false if none could be loaded.
1939 protected function getBlockFromCookieValue( $blockCookieVal ) {
1940 // Make sure there's something to check. The cookie value must start with a number.
1941 if ( strlen( $blockCookieVal ) < 1 ||
!is_numeric( substr( $blockCookieVal, 0, 1 ) ) ) {
1944 // Load the Block from the ID in the cookie.
1945 $blockCookieId = Block
::getIdFromCookieValue( $blockCookieVal );
1946 if ( $blockCookieId !== null ) {
1947 // An ID was found in the cookie.
1948 $tmpBlock = Block
::newFromID( $blockCookieId );
1949 if ( $tmpBlock instanceof Block
) {
1950 $config = RequestContext
::getMain()->getConfig();
1952 switch ( $tmpBlock->getType() ) {
1953 case Block
::TYPE_USER
:
1954 $blockIsValid = !$tmpBlock->isExpired() && $tmpBlock->isAutoblocking();
1955 $useBlockCookie = ( $config->get( 'CookieSetOnAutoblock' ) === true );
1957 case Block
::TYPE_IP
:
1958 case Block
::TYPE_RANGE
:
1959 // If block is type IP or IP range, load only if user is not logged in (T152462)
1960 $blockIsValid = !$tmpBlock->isExpired() && !$this->isLoggedIn();
1961 $useBlockCookie = ( $config->get( 'CookieSetOnIpBlock' ) === true );
1964 $blockIsValid = false;
1965 $useBlockCookie = false;
1968 if ( $blockIsValid && $useBlockCookie ) {
1972 // If the block is not valid, remove the cookie.
1973 Block
::clearCookie( $this->getRequest()->response() );
1976 // If the block doesn't exist, remove the cookie.
1977 Block
::clearCookie( $this->getRequest()->response() );
1984 * Whether the given IP is in a DNS blacklist.
1986 * @param string $ip IP to check
1987 * @param bool $checkWhitelist Whether to check the whitelist first
1988 * @return bool True if blacklisted.
1990 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1991 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1993 if ( !$wgEnableDnsBlacklist ) {
1997 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
2001 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
2005 * Whether the given IP is in a given DNS blacklist.
2007 * @param string $ip IP to check
2008 * @param string|array $bases Array of Strings: URL of the DNS blacklist
2009 * @return bool True if blacklisted.
2011 public function inDnsBlacklist( $ip, $bases ) {
2013 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
2014 if ( IP
::isIPv4( $ip ) ) {
2015 // Reverse IP, T23255
2016 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
2018 foreach ( (array)$bases as $base ) {
2020 // If we have an access key, use that too (ProjectHoneypot, etc.)
2022 if ( is_array( $base ) ) {
2023 if ( count( $base ) >= 2 ) {
2024 // Access key is 1, base URL is 0
2025 $host = "{$base[1]}.$ipReversed.{$base[0]}";
2027 $host = "$ipReversed.{$base[0]}";
2029 $basename = $base[0];
2031 $host = "$ipReversed.$base";
2035 $ipList = gethostbynamel( $host );
2038 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
2042 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
2051 * Check if an IP address is in the local proxy list
2057 public static function isLocallyBlockedProxy( $ip ) {
2058 global $wgProxyList;
2060 if ( !$wgProxyList ) {
2064 if ( !is_array( $wgProxyList ) ) {
2065 // Load values from the specified file
2066 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
2069 $resultProxyList = [];
2070 $deprecatedIPEntries = [];
2072 // backward compatibility: move all ip addresses in keys to values
2073 foreach ( $wgProxyList as $key => $value ) {
2074 $keyIsIP = IP
::isIPAddress( $key );
2075 $valueIsIP = IP
::isIPAddress( $value );
2076 if ( $keyIsIP && !$valueIsIP ) {
2077 $deprecatedIPEntries[] = $key;
2078 $resultProxyList[] = $key;
2079 } elseif ( $keyIsIP && $valueIsIP ) {
2080 $deprecatedIPEntries[] = $key;
2081 $resultProxyList[] = $key;
2082 $resultProxyList[] = $value;
2084 $resultProxyList[] = $value;
2088 if ( $deprecatedIPEntries ) {
2090 'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
2091 implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
2094 $proxyListIPSet = new IPSet( $resultProxyList );
2095 return $proxyListIPSet->match( $ip );
2099 * Is this user subject to rate limiting?
2101 * @return bool True if rate limited
2103 public function isPingLimitable() {
2104 global $wgRateLimitsExcludedIPs;
2105 if ( IP
::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
2106 // No other good way currently to disable rate limits
2107 // for specific IPs. :P
2108 // But this is a crappy hack and should die.
2111 return !$this->isAllowed( 'noratelimit' );
2115 * Primitive rate limits: enforce maximum actions per time period
2116 * to put a brake on flooding.
2118 * The method generates both a generic profiling point and a per action one
2119 * (suffix being "-$action".
2121 * @note When using a shared cache like memcached, IP-address
2122 * last-hit counters will be shared across wikis.
2124 * @param string $action Action to enforce; 'edit' if unspecified
2125 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
2126 * @return bool True if a rate limiter was tripped
2128 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
2129 // Avoid PHP 7.1 warning of passing $this by reference
2131 // Call the 'PingLimiter' hook
2133 if ( !Hooks
::run( 'PingLimiter', [ &$user, $action, &$result, $incrBy ] ) ) {
2137 global $wgRateLimits;
2138 if ( !isset( $wgRateLimits[$action] ) ) {
2142 $limits = array_merge(
2143 [ '&can-bypass' => true ],
2144 $wgRateLimits[$action]
2147 // Some groups shouldn't trigger the ping limiter, ever
2148 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
2153 $id = $this->getId();
2155 $isNewbie = $this->isNewbie();
2156 $cache = ObjectCache
::getLocalClusterInstance();
2160 if ( isset( $limits['anon'] ) ) {
2161 $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
2164 // limits for logged-in users
2165 if ( isset( $limits['user'] ) ) {
2166 $userLimit = $limits['user'];
2168 // limits for newbie logged-in users
2169 if ( $isNewbie && isset( $limits['newbie'] ) ) {
2170 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
2174 // limits for anons and for newbie logged-in users
2177 if ( isset( $limits['ip'] ) ) {
2178 $ip = $this->getRequest()->getIP();
2179 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
2181 // subnet-based limits
2182 if ( isset( $limits['subnet'] ) ) {
2183 $ip = $this->getRequest()->getIP();
2184 $subnet = IP
::getSubnet( $ip );
2185 if ( $subnet !== false ) {
2186 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
2191 // Check for group-specific permissions
2192 // If more than one group applies, use the group with the highest limit ratio (max/period)
2193 foreach ( $this->getGroups() as $group ) {
2194 if ( isset( $limits[$group] ) ) {
2195 if ( $userLimit === false
2196 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
2198 $userLimit = $limits[$group];
2203 // Set the user limit key
2204 if ( $userLimit !== false ) {
2205 list( $max, $period ) = $userLimit;
2206 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
2207 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
2210 // ip-based limits for all ping-limitable users
2211 if ( isset( $limits['ip-all'] ) ) {
2212 $ip = $this->getRequest()->getIP();
2213 // ignore if user limit is more permissive
2214 if ( $isNewbie ||
$userLimit === false
2215 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
2216 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
2220 // subnet-based limits for all ping-limitable users
2221 if ( isset( $limits['subnet-all'] ) ) {
2222 $ip = $this->getRequest()->getIP();
2223 $subnet = IP
::getSubnet( $ip );
2224 if ( $subnet !== false ) {
2225 // ignore if user limit is more permissive
2226 if ( $isNewbie ||
$userLimit === false
2227 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
2228 > $userLimit[0] / $userLimit[1] ) {
2229 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
2235 foreach ( $keys as $key => $limit ) {
2236 list( $max, $period ) = $limit;
2237 $summary = "(limit $max in {$period}s)";
2238 $count = $cache->get( $key );
2241 if ( $count >= $max ) {
2242 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
2243 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
2246 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
2249 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
2250 if ( $incrBy > 0 ) {
2251 $cache->add( $key, 0, intval( $period ) ); // first ping
2254 if ( $incrBy > 0 ) {
2255 $cache->incr( $key, $incrBy );
2263 * Check if user is blocked
2265 * @param bool $bFromSlave Whether to check the replica DB instead of
2266 * the master. Hacked from false due to horrible probs on site.
2267 * @return bool True if blocked, false otherwise
2269 public function isBlocked( $bFromSlave = true ) {
2270 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
2274 * Get the block affecting the user, or null if the user is not blocked
2276 * @param bool $bFromSlave Whether to check the replica DB instead of the master
2277 * @return Block|null
2279 public function getBlock( $bFromSlave = true ) {
2280 $this->getBlockedStatus( $bFromSlave );
2281 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
2285 * Check if user is blocked from editing a particular article
2287 * @param Title $title Title to check
2288 * @param bool $bFromSlave Whether to check the replica DB instead of the master
2291 public function isBlockedFrom( $title, $bFromSlave = false ) {
2292 global $wgBlockAllowsUTEdit;
2294 $blocked = $this->isBlocked( $bFromSlave );
2295 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
2296 // If a user's name is suppressed, they cannot make edits anywhere
2297 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName()
2298 && $title->getNamespace() == NS_USER_TALK
) {
2300 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
2303 Hooks
::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
2309 * If user is blocked, return the name of the user who placed the block
2310 * @return string Name of blocker
2312 public function blockedBy() {
2313 $this->getBlockedStatus();
2314 return $this->mBlockedby
;
2318 * If user is blocked, return the specified reason for the block
2319 * @return string Blocking reason
2321 public function blockedFor() {
2322 $this->getBlockedStatus();
2323 return $this->mBlockreason
;
2327 * If user is blocked, return the ID for the block
2328 * @return int Block ID
2330 public function getBlockId() {
2331 $this->getBlockedStatus();
2332 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2336 * Check if user is blocked on all wikis.
2337 * Do not use for actual edit permission checks!
2338 * This is intended for quick UI checks.
2340 * @param string $ip IP address, uses current client if none given
2341 * @return bool True if blocked, false otherwise
2343 public function isBlockedGlobally( $ip = '' ) {
2344 return $this->getGlobalBlock( $ip ) instanceof Block
;
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 Block|null Block object if blocked, null otherwise
2354 * @throws FatalError
2355 * @throws MWException
2357 public function getGlobalBlock( $ip = '' ) {
2358 if ( $this->mGlobalBlock
!== null ) {
2359 return $this->mGlobalBlock ?
: null;
2361 // User is already an IP?
2362 if ( IP
::isIPAddress( $this->getName() ) ) {
2363 $ip = $this->getName();
2365 $ip = $this->getRequest()->getIP();
2367 // Avoid PHP 7.1 warning of passing $this by reference
2371 Hooks
::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
2373 if ( $blocked && $block === null ) {
2374 // back-compat: UserIsBlockedGlobally didn't have $block param first
2375 $block = new Block( [
2377 'systemBlock' => 'global-block'
2381 $this->mGlobalBlock
= $blocked ?
$block : false;
2382 return $this->mGlobalBlock ?
: null;
2386 * Check if user account is locked
2388 * @return bool True if locked, false otherwise
2390 public function isLocked() {
2391 if ( $this->mLocked
!== null ) {
2392 return $this->mLocked
;
2394 // Avoid PHP 7.1 warning of passing $this by reference
2396 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$user ], null );
2397 $this->mLocked
= $authUser && $authUser->isLocked();
2398 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2399 return $this->mLocked
;
2403 * Check if user account is hidden
2405 * @return bool True if hidden, false otherwise
2407 public function isHidden() {
2408 if ( $this->mHideName
!== null ) {
2409 return $this->mHideName
;
2411 $this->getBlockedStatus();
2412 if ( !$this->mHideName
) {
2413 // Avoid PHP 7.1 warning of passing $this by reference
2415 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$user ], null );
2416 $this->mHideName
= $authUser && $authUser->isHidden();
2417 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2419 return $this->mHideName
;
2423 * Get the user's ID.
2424 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2426 public function getId() {
2427 if ( $this->mId
=== null && $this->mName
!== null && self
::isIP( $this->mName
) ) {
2428 // Special case, we know the user is anonymous
2430 } elseif ( !$this->isItemLoaded( 'id' ) ) {
2431 // Don't load if this was initialized from an ID
2435 return (int)$this->mId
;
2439 * Set the user and reload all fields according to a given ID
2440 * @param int $v User ID to reload
2442 public function setId( $v ) {
2444 $this->clearInstanceCache( 'id' );
2448 * Get the user name, or the IP of an anonymous user
2449 * @return string User's name or IP address
2451 public function getName() {
2452 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2453 // Special case optimisation
2454 return $this->mName
;
2457 if ( $this->mName
=== false ) {
2459 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2461 return $this->mName
;
2466 * Set the user name.
2468 * This does not reload fields from the database according to the given
2469 * name. Rather, it is used to create a temporary "nonexistent user" for
2470 * later addition to the database. It can also be used to set the IP
2471 * address for an anonymous user to something other than the current
2474 * @note User::newFromName() has roughly the same function, when the named user
2476 * @param string $str New user name to set
2478 public function setName( $str ) {
2480 $this->mName
= $str;
2484 * Get the user's actor ID.
2486 * @param IDatabase|null $dbw Assign a new actor ID, using this DB handle, if none exists
2487 * @return int The actor's ID, or 0 if no actor ID exists and $dbw was null
2489 public function getActorId( IDatabase
$dbw = null ) {
2490 global $wgActorTableSchemaMigrationStage;
2492 if ( $wgActorTableSchemaMigrationStage <= MIGRATION_OLD
) {
2496 if ( !$this->isItemLoaded( 'actor' ) ) {
2500 // Currently $this->mActorId might be null if $this was loaded from a
2501 // cache entry that was written when $wgActorTableSchemaMigrationStage
2502 // was MIGRATION_OLD. Once that is no longer a possibility (i.e. when
2503 // User::VERSION is incremented after $wgActorTableSchemaMigrationStage
2504 // has been removed), that condition may be removed.
2505 if ( $this->mActorId
=== null ||
!$this->mActorId
&& $dbw ) {
2507 'actor_user' => $this->getId() ?
: null,
2508 'actor_name' => (string)$this->getName(),
2511 if ( $q['actor_user'] === null && self
::isUsableName( $q['actor_name'] ) ) {
2512 throw new CannotCreateActorException(
2513 'Cannot create an actor for a usable name that is not an existing user'
2516 if ( $q['actor_name'] === '' ) {
2517 throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
2519 $dbw->insert( 'actor', $q, __METHOD__
, [ 'IGNORE' ] );
2520 if ( $dbw->affectedRows() ) {
2521 $this->mActorId
= (int)$dbw->insertId();
2524 list( , $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2525 $this->mActorId
= (int)$dbw->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2526 if ( !$this->mActorId
) {
2527 throw new CannotCreateActorException(
2528 "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
2532 $this->invalidateCache();
2534 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2535 $db = wfGetDB( $index );
2536 $this->mActorId
= (int)$db->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2538 $this->setItemLoaded( 'actor' );
2541 return (int)$this->mActorId
;
2545 * Get the user's name escaped by underscores.
2546 * @return string Username escaped by underscores.
2548 public function getTitleKey() {
2549 return str_replace( ' ', '_', $this->getName() );
2553 * Check if the user has new messages.
2554 * @return bool True if the user has new messages
2556 public function getNewtalk() {
2559 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2560 if ( $this->mNewtalk
=== -1 ) {
2561 $this->mNewtalk
= false; # reset talk page status
2563 // Check memcached separately for anons, who have no
2564 // entire User object stored in there.
2565 if ( !$this->mId
) {
2566 global $wgDisableAnonTalk;
2567 if ( $wgDisableAnonTalk ) {
2568 // Anon newtalk disabled by configuration.
2569 $this->mNewtalk
= false;
2571 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2574 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2578 return (bool)$this->mNewtalk
;
2582 * Return the data needed to construct links for new talk page message
2583 * alerts. If there are new messages, this will return an associative array
2584 * with the following data:
2585 * wiki: The database name of the wiki
2586 * link: Root-relative link to the user's talk page
2587 * rev: The last talk page revision that the user has seen or null. This
2588 * is useful for building diff links.
2589 * If there are no new messages, it returns an empty array.
2590 * @note This function was designed to accomodate multiple talk pages, but
2591 * currently only returns a single link and revision.
2594 public function getNewMessageLinks() {
2595 // Avoid PHP 7.1 warning of passing $this by reference
2598 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
2600 } elseif ( !$this->getNewtalk() ) {
2603 $utp = $this->getTalkPage();
2604 $dbr = wfGetDB( DB_REPLICA
);
2605 // Get the "last viewed rev" timestamp from the oldest message notification
2606 $timestamp = $dbr->selectField( 'user_newtalk',
2607 'MIN(user_last_timestamp)',
2608 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2610 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2611 return [ [ 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ] ];
2615 * Get the revision ID for the last talk page revision viewed by the talk
2617 * @return int|null Revision ID or null
2619 public function getNewMessageRevisionId() {
2620 $newMessageRevisionId = null;
2621 $newMessageLinks = $this->getNewMessageLinks();
2622 if ( $newMessageLinks ) {
2623 // Note: getNewMessageLinks() never returns more than a single link
2624 // and it is always for the same wiki, but we double-check here in
2625 // case that changes some time in the future.
2626 if ( count( $newMessageLinks ) === 1
2627 && $newMessageLinks[0]['wiki'] === wfWikiID()
2628 && $newMessageLinks[0]['rev']
2630 /** @var Revision $newMessageRevision */
2631 $newMessageRevision = $newMessageLinks[0]['rev'];
2632 $newMessageRevisionId = $newMessageRevision->getId();
2635 return $newMessageRevisionId;
2639 * Internal uncached check for new messages
2642 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2643 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2644 * @return bool True if the user has new messages
2646 protected function checkNewtalk( $field, $id ) {
2647 $dbr = wfGetDB( DB_REPLICA
);
2649 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2651 return $ok !== false;
2655 * Add or update the new messages flag
2656 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2657 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2658 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2659 * @return bool True if successful, false otherwise
2661 protected function updateNewtalk( $field, $id, $curRev = null ) {
2662 // Get timestamp of the talk page revision prior to the current one
2663 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2664 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2665 // Mark the user as having new messages since this revision
2666 $dbw = wfGetDB( DB_MASTER
);
2667 $dbw->insert( 'user_newtalk',
2668 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2671 if ( $dbw->affectedRows() ) {
2672 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2675 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2681 * Clear the new messages flag for the given user
2682 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2683 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2684 * @return bool True if successful, false otherwise
2686 protected function deleteNewtalk( $field, $id ) {
2687 $dbw = wfGetDB( DB_MASTER
);
2688 $dbw->delete( 'user_newtalk',
2691 if ( $dbw->affectedRows() ) {
2692 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2695 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2701 * Update the 'You have new messages!' status.
2702 * @param bool $val Whether the user has new messages
2703 * @param Revision|null $curRev New, as yet unseen revision of the user talk
2704 * page. Ignored if null or !$val.
2706 public function setNewtalk( $val, $curRev = null ) {
2707 if ( wfReadOnly() ) {
2712 $this->mNewtalk
= $val;
2714 if ( $this->isAnon() ) {
2716 $id = $this->getName();
2719 $id = $this->getId();
2723 $changed = $this->updateNewtalk( $field, $id, $curRev );
2725 $changed = $this->deleteNewtalk( $field, $id );
2729 $this->invalidateCache();
2734 * Generate a current or new-future timestamp to be stored in the
2735 * user_touched field when we update things.
2736 * @return string Timestamp in TS_MW format
2738 private function newTouchedTimestamp() {
2739 global $wgClockSkewFudge;
2741 $time = wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2742 if ( $this->mTouched
&& $time <= $this->mTouched
) {
2743 $time = wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2750 * Clear user data from memcached
2752 * Use after applying updates to the database; caller's
2753 * responsibility to update user_touched if appropriate.
2755 * Called implicitly from invalidateCache() and saveSettings().
2757 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2759 public function clearSharedCache( $mode = 'changed' ) {
2760 if ( !$this->getId() ) {
2764 $cache = ObjectCache
::getMainWANInstance();
2765 $key = $this->getCacheKey( $cache );
2766 if ( $mode === 'refresh' ) {
2767 $cache->delete( $key, 1 );
2769 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2770 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2771 $lb->getConnection( DB_MASTER
)->onTransactionPreCommitOrIdle(
2772 function () use ( $cache, $key ) {
2773 $cache->delete( $key );
2778 $cache->delete( $key );
2784 * Immediately touch the user data cache for this account
2786 * Calls touch() and removes account data from memcached
2788 public function invalidateCache() {
2790 $this->clearSharedCache();
2794 * Update the "touched" timestamp for the user
2796 * This is useful on various login/logout events when making sure that
2797 * a browser or proxy that has multiple tenants does not suffer cache
2798 * pollution where the new user sees the old users content. The value
2799 * of getTouched() is checked when determining 304 vs 200 responses.
2800 * Unlike invalidateCache(), this preserves the User object cache and
2801 * avoids database writes.
2805 public function touch() {
2806 $id = $this->getId();
2808 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2809 $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
2810 $cache->touchCheckKey( $key );
2811 $this->mQuickTouched
= null;
2816 * Validate the cache for this account.
2817 * @param string $timestamp A timestamp in TS_MW format
2820 public function validateCache( $timestamp ) {
2821 return ( $timestamp >= $this->getTouched() );
2825 * Get the user touched timestamp
2827 * Use this value only to validate caches via inequalities
2828 * such as in the case of HTTP If-Modified-Since response logic
2830 * @return string TS_MW Timestamp
2832 public function getTouched() {
2836 if ( $this->mQuickTouched
=== null ) {
2837 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2838 $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId
);
2840 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2843 return max( $this->mTouched
, $this->mQuickTouched
);
2846 return $this->mTouched
;
2850 * Get the user_touched timestamp field (time of last DB updates)
2851 * @return string TS_MW Timestamp
2854 public function getDBTouched() {
2857 return $this->mTouched
;
2861 * Set the password and reset the random token.
2862 * Calls through to authentication plugin if necessary;
2863 * will have no effect if the auth plugin refuses to
2864 * pass the change through or if the legal password
2867 * As a special case, setting the password to null
2868 * wipes it, so the account cannot be logged in until
2869 * a new password is set, for instance via e-mail.
2871 * @deprecated since 1.27, use AuthManager instead
2872 * @param string $str New password to set
2873 * @throws PasswordError On failure
2876 public function setPassword( $str ) {
2877 return $this->setPasswordInternal( $str );
2881 * Set the password and reset the random token unconditionally.
2883 * @deprecated since 1.27, use AuthManager instead
2884 * @param string|null $str New password to set or null to set an invalid
2885 * password hash meaning that the user will not be able to log in
2886 * through the web interface.
2888 public function setInternalPassword( $str ) {
2889 $this->setPasswordInternal( $str );
2893 * Actually set the password and such
2894 * @since 1.27 cannot set a password for a user not in the database
2895 * @param string|null $str New password to set or null to set an invalid
2896 * password hash meaning that the user will not be able to log in
2897 * through the web interface.
2898 * @return bool Success
2900 private function setPasswordInternal( $str ) {
2901 $manager = AuthManager
::singleton();
2903 // If the user doesn't exist yet, fail
2904 if ( !$manager->userExists( $this->getName() ) ) {
2905 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2908 $status = $this->changeAuthenticationData( [
2909 'username' => $this->getName(),
2913 if ( !$status->isGood() ) {
2914 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2915 ->info( __METHOD__
. ': Password change rejected: '
2916 . $status->getWikiText( null, null, 'en' ) );
2920 $this->setOption( 'watchlisttoken', false );
2921 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2927 * Changes credentials of the user.
2929 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2930 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2931 * e.g. when no provider handled the change.
2933 * @param array $data A set of authentication data in fieldname => value format. This is the
2934 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2938 public function changeAuthenticationData( array $data ) {
2939 $manager = AuthManager
::singleton();
2940 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2941 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2943 $status = Status
::newGood( 'ignored' );
2944 foreach ( $reqs as $req ) {
2945 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2947 if ( $status->getValue() === 'ignored' ) {
2948 $status->warning( 'authenticationdatachange-ignored' );
2951 if ( $status->isGood() ) {
2952 foreach ( $reqs as $req ) {
2953 $manager->changeAuthenticationData( $req );
2960 * Get the user's current token.
2961 * @param bool $forceCreation Force the generation of a new token if the
2962 * user doesn't have one (default=true for backwards compatibility).
2963 * @return string|null Token
2965 public function getToken( $forceCreation = true ) {
2966 global $wgAuthenticationTokenVersion;
2969 if ( !$this->mToken
&& $forceCreation ) {
2973 if ( !$this->mToken
) {
2974 // The user doesn't have a token, return null to indicate that.
2976 } elseif ( $this->mToken
=== self
::INVALID_TOKEN
) {
2977 // We return a random value here so existing token checks are very
2979 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2980 } elseif ( $wgAuthenticationTokenVersion === null ) {
2981 // $wgAuthenticationTokenVersion not in use, so return the raw secret
2982 return $this->mToken
;
2984 // $wgAuthenticationTokenVersion in use, so hmac it.
2985 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
2987 // The raw hash can be overly long. Shorten it up.
2988 $len = max( 32, self
::TOKEN_LENGTH
);
2989 if ( strlen( $ret ) < $len ) {
2990 // Should never happen, even md5 is 128 bits
2991 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
2993 return substr( $ret, -$len );
2998 * Set the random token (used for persistent authentication)
2999 * Called from loadDefaults() among other places.
3001 * @param string|bool $token If specified, set the token to this value
3003 public function setToken( $token = false ) {
3005 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
3006 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3007 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
3008 } elseif ( !$token ) {
3009 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3011 $this->mToken
= $token;
3016 * Set the password for a password reminder or new account email
3018 * @deprecated Removed in 1.27. Use PasswordReset instead.
3019 * @param string $str New password to set or null to set an invalid
3020 * password hash meaning that the user will not be able to use it
3021 * @param bool $throttle If true, reset the throttle timestamp to the present
3023 public function setNewpassword( $str, $throttle = true ) {
3024 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
3028 * Get the user's e-mail address
3029 * @return string User's email address
3031 public function getEmail() {
3033 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
3034 return $this->mEmail
;
3038 * Get the timestamp of the user's e-mail authentication
3039 * @return string TS_MW timestamp
3041 public function getEmailAuthenticationTimestamp() {
3043 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
3044 return $this->mEmailAuthenticated
;
3048 * Set the user's e-mail address
3049 * @param string $str New e-mail address
3051 public function setEmail( $str ) {
3053 if ( $str == $this->mEmail
) {
3056 $this->invalidateEmail();
3057 $this->mEmail
= $str;
3058 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
3062 * Set the user's e-mail address and a confirmation mail if needed.
3065 * @param string $str New e-mail address
3068 public function setEmailWithConfirmation( $str ) {
3069 global $wgEnableEmail, $wgEmailAuthentication;
3071 if ( !$wgEnableEmail ) {
3072 return Status
::newFatal( 'emaildisabled' );
3075 $oldaddr = $this->getEmail();
3076 if ( $str === $oldaddr ) {
3077 return Status
::newGood( true );
3080 $type = $oldaddr != '' ?
'changed' : 'set';
3081 $notificationResult = null;
3083 if ( $wgEmailAuthentication ) {
3084 // Send the user an email notifying the user of the change in registered
3085 // email address on their previous email address
3086 if ( $type == 'changed' ) {
3087 $change = $str != '' ?
'changed' : 'removed';
3088 $notificationResult = $this->sendMail(
3089 wfMessage( 'notificationemail_subject_' . $change )->text(),
3090 wfMessage( 'notificationemail_body_' . $change,
3091 $this->getRequest()->getIP(),
3098 $this->setEmail( $str );
3100 if ( $str !== '' && $wgEmailAuthentication ) {
3101 // Send a confirmation request to the new address if needed
3102 $result = $this->sendConfirmationMail( $type );
3104 if ( $notificationResult !== null ) {
3105 $result->merge( $notificationResult );
3108 if ( $result->isGood() ) {
3109 // Say to the caller that a confirmation and notification mail has been sent
3110 $result->value
= 'eauth';
3113 $result = Status
::newGood( true );
3120 * Get the user's real name
3121 * @return string User's real name
3123 public function getRealName() {
3124 if ( !$this->isItemLoaded( 'realname' ) ) {
3128 return $this->mRealName
;
3132 * Set the user's real name
3133 * @param string $str New real name
3135 public function setRealName( $str ) {
3137 $this->mRealName
= $str;
3141 * Get the user's current setting for a given option.
3143 * @param string $oname The option to check
3144 * @param string|array|null $defaultOverride A default value returned if the option does not exist
3145 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
3146 * @return string|array|int|null User's current value for the option
3147 * @see getBoolOption()
3148 * @see getIntOption()
3150 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
3151 global $wgHiddenPrefs;
3152 $this->loadOptions();
3154 # We want 'disabled' preferences to always behave as the default value for
3155 # users, even if they have set the option explicitly in their settings (ie they
3156 # set it, and then it was disabled removing their ability to change it). But
3157 # we don't want to erase the preferences in the database in case the preference
3158 # is re-enabled again. So don't touch $mOptions, just override the returned value
3159 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
3160 return self
::getDefaultOption( $oname );
3163 if ( array_key_exists( $oname, $this->mOptions
) ) {
3164 return $this->mOptions
[$oname];
3166 return $defaultOverride;
3171 * Get all user's options
3173 * @param int $flags Bitwise combination of:
3174 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
3175 * to the default value. (Since 1.25)
3178 public function getOptions( $flags = 0 ) {
3179 global $wgHiddenPrefs;
3180 $this->loadOptions();
3181 $options = $this->mOptions
;
3183 # We want 'disabled' preferences to always behave as the default value for
3184 # users, even if they have set the option explicitly in their settings (ie they
3185 # set it, and then it was disabled removing their ability to change it). But
3186 # we don't want to erase the preferences in the database in case the preference
3187 # is re-enabled again. So don't touch $mOptions, just override the returned value
3188 foreach ( $wgHiddenPrefs as $pref ) {
3189 $default = self
::getDefaultOption( $pref );
3190 if ( $default !== null ) {
3191 $options[$pref] = $default;
3195 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
3196 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
3203 * Get the user's current setting for a given option, as a boolean value.
3205 * @param string $oname The option to check
3206 * @return bool User's current value for the option
3209 public function getBoolOption( $oname ) {
3210 return (bool)$this->getOption( $oname );
3214 * Get the user's current setting for a given option, as an integer value.
3216 * @param string $oname The option to check
3217 * @param int $defaultOverride A default value returned if the option does not exist
3218 * @return int User's current value for the option
3221 public function getIntOption( $oname, $defaultOverride = 0 ) {
3222 $val = $this->getOption( $oname );
3224 $val = $defaultOverride;
3226 return intval( $val );
3230 * Set the given option for a user.
3232 * You need to call saveSettings() to actually write to the database.
3234 * @param string $oname The option to set
3235 * @param mixed $val New value to set
3237 public function setOption( $oname, $val ) {
3238 $this->loadOptions();
3240 // Explicitly NULL values should refer to defaults
3241 if ( is_null( $val ) ) {
3242 $val = self
::getDefaultOption( $oname );
3245 $this->mOptions
[$oname] = $val;
3249 * Get a token stored in the preferences (like the watchlist one),
3250 * resetting it if it's empty (and saving changes).
3252 * @param string $oname The option name to retrieve the token from
3253 * @return string|bool User's current value for the option, or false if this option is disabled.
3254 * @see resetTokenFromOption()
3256 * @deprecated since 1.26 Applications should use the OAuth extension
3258 public function getTokenFromOption( $oname ) {
3259 global $wgHiddenPrefs;
3261 $id = $this->getId();
3262 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
3266 $token = $this->getOption( $oname );
3268 // Default to a value based on the user token to avoid space
3269 // wasted on storing tokens for all users. When this option
3270 // is set manually by the user, only then is it stored.
3271 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
3278 * Reset a token stored in the preferences (like the watchlist one).
3279 * *Does not* save user's preferences (similarly to setOption()).
3281 * @param string $oname The option name to reset the token in
3282 * @return string|bool New token value, or false if this option is disabled.
3283 * @see getTokenFromOption()
3286 public function resetTokenFromOption( $oname ) {
3287 global $wgHiddenPrefs;
3288 if ( in_array( $oname, $wgHiddenPrefs ) ) {
3292 $token = MWCryptRand
::generateHex( 40 );
3293 $this->setOption( $oname, $token );
3298 * Return a list of the types of user options currently returned by
3299 * User::getOptionKinds().
3301 * Currently, the option kinds are:
3302 * - 'registered' - preferences which are registered in core MediaWiki or
3303 * by extensions using the UserGetDefaultOptions hook.
3304 * - 'registered-multiselect' - as above, using the 'multiselect' type.
3305 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
3306 * - 'userjs' - preferences with names starting with 'userjs-', intended to
3307 * be used by user scripts.
3308 * - 'special' - "preferences" that are not accessible via User::getOptions
3309 * or User::setOptions.
3310 * - 'unused' - preferences about which MediaWiki doesn't know anything.
3311 * These are usually legacy options, removed in newer versions.
3313 * The API (and possibly others) use this function to determine the possible
3314 * option types for validation purposes, so make sure to update this when a
3315 * new option kind is added.
3317 * @see User::getOptionKinds
3318 * @return array Option kinds
3320 public static function listOptionKinds() {
3323 'registered-multiselect',
3324 'registered-checkmatrix',
3332 * Return an associative array mapping preferences keys to the kind of a preference they're
3333 * used for. Different kinds are handled differently when setting or reading preferences.
3335 * See User::listOptionKinds for the list of valid option types that can be provided.
3337 * @see User::listOptionKinds
3338 * @param IContextSource $context
3339 * @param array|null $options Assoc. array with options keys to check as keys.
3340 * Defaults to $this->mOptions.
3341 * @return array The key => kind mapping data
3343 public function getOptionKinds( IContextSource
$context, $options = null ) {
3344 $this->loadOptions();
3345 if ( $options === null ) {
3346 $options = $this->mOptions
;
3349 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
3350 $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
3353 // Pull out the "special" options, so they don't get converted as
3354 // multiselect or checkmatrix.
3355 $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
3356 foreach ( $specialOptions as $name => $value ) {
3357 unset( $prefs[$name] );
3360 // Multiselect and checkmatrix options are stored in the database with
3361 // one key per option, each having a boolean value. Extract those keys.
3362 $multiselectOptions = [];
3363 foreach ( $prefs as $name => $info ) {
3364 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3365 ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField
::class ) ) {
3366 $opts = HTMLFormField
::flattenOptions( $info['options'] );
3367 $prefix = $info['prefix'] ??
$name;
3369 foreach ( $opts as $value ) {
3370 $multiselectOptions["$prefix$value"] = true;
3373 unset( $prefs[$name] );
3376 $checkmatrixOptions = [];
3377 foreach ( $prefs as $name => $info ) {
3378 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3379 ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix
::class ) ) {
3380 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3381 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3382 $prefix = $info['prefix'] ??
$name;
3384 foreach ( $columns as $column ) {
3385 foreach ( $rows as $row ) {
3386 $checkmatrixOptions["$prefix$column-$row"] = true;
3390 unset( $prefs[$name] );
3394 // $value is ignored
3395 foreach ( $options as $key => $value ) {
3396 if ( isset( $prefs[$key] ) ) {
3397 $mapping[$key] = 'registered';
3398 } elseif ( isset( $multiselectOptions[$key] ) ) {
3399 $mapping[$key] = 'registered-multiselect';
3400 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3401 $mapping[$key] = 'registered-checkmatrix';
3402 } elseif ( isset( $specialOptions[$key] ) ) {
3403 $mapping[$key] = 'special';
3404 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3405 $mapping[$key] = 'userjs';
3407 $mapping[$key] = 'unused';
3415 * Reset certain (or all) options to the site defaults
3417 * The optional parameter determines which kinds of preferences will be reset.
3418 * Supported values are everything that can be reported by getOptionKinds()
3419 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3421 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3422 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3423 * for backwards-compatibility.
3424 * @param IContextSource|null $context Context source used when $resetKinds
3425 * does not contain 'all', passed to getOptionKinds().
3426 * Defaults to RequestContext::getMain() when null.
3428 public function resetOptions(
3429 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3430 IContextSource
$context = null
3433 $defaultOptions = self
::getDefaultOptions();
3435 if ( !is_array( $resetKinds ) ) {
3436 $resetKinds = [ $resetKinds ];
3439 if ( in_array( 'all', $resetKinds ) ) {
3440 $newOptions = $defaultOptions;
3442 if ( $context === null ) {
3443 $context = RequestContext
::getMain();
3446 $optionKinds = $this->getOptionKinds( $context );
3447 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3450 // Use default values for the options that should be deleted, and
3451 // copy old values for the ones that shouldn't.
3452 foreach ( $this->mOptions
as $key => $value ) {
3453 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3454 if ( array_key_exists( $key, $defaultOptions ) ) {
3455 $newOptions[$key] = $defaultOptions[$key];
3458 $newOptions[$key] = $value;
3463 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3465 $this->mOptions
= $newOptions;
3466 $this->mOptionsLoaded
= true;
3470 * Get the user's preferred date format.
3471 * @return string User's preferred date format
3473 public function getDatePreference() {
3474 // Important migration for old data rows
3475 if ( is_null( $this->mDatePreference
) ) {
3477 $value = $this->getOption( 'date' );
3478 $map = $wgLang->getDatePreferenceMigrationMap();
3479 if ( isset( $map[$value] ) ) {
3480 $value = $map[$value];
3482 $this->mDatePreference
= $value;
3484 return $this->mDatePreference
;
3488 * Determine based on the wiki configuration and the user's options,
3489 * whether this user must be over HTTPS no matter what.
3493 public function requiresHTTPS() {
3494 global $wgSecureLogin;
3495 if ( !$wgSecureLogin ) {
3498 $https = $this->getBoolOption( 'prefershttps' );
3499 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3501 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3508 * Get the user preferred stub threshold
3512 public function getStubThreshold() {
3513 global $wgMaxArticleSize; # Maximum article size, in Kb
3514 $threshold = $this->getIntOption( 'stubthreshold' );
3515 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3516 // If they have set an impossible value, disable the preference
3517 // so we can use the parser cache again.
3524 * Get the permissions this user has.
3525 * @return string[] permission names
3527 public function getRights() {
3528 if ( is_null( $this->mRights
) ) {
3529 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3530 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3532 // Deny any rights denied by the user's session, unless this
3533 // endpoint has no sessions.
3534 if ( !defined( 'MW_NO_SESSION' ) ) {
3535 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3536 if ( $allowedRights !== null ) {
3537 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3541 // Force reindexation of rights when a hook has unset one of them
3542 $this->mRights
= array_values( array_unique( $this->mRights
) );
3544 // If block disables login, we should also remove any
3545 // extra rights blocked users might have, in case the
3546 // blocked user has a pre-existing session (T129738).
3547 // This is checked here for cases where people only call
3548 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3549 // to give a better error message in the common case.
3550 $config = RequestContext
::getMain()->getConfig();
3552 $this->isLoggedIn() &&
3553 $config->get( 'BlockDisablesLogin' ) &&
3557 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3560 return $this->mRights
;
3564 * Get the list of explicit group memberships this user has.
3565 * The implicit * and user groups are not included.
3566 * @return array Array of String internal group names
3568 public function getGroups() {
3570 $this->loadGroups();
3571 return array_keys( $this->mGroupMemberships
);
3575 * Get the list of explicit group memberships this user has, stored as
3576 * UserGroupMembership objects. Implicit groups are not included.
3578 * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
3581 public function getGroupMemberships() {
3583 $this->loadGroups();
3584 return $this->mGroupMemberships
;
3588 * Get the list of implicit group memberships this user has.
3589 * This includes all explicit groups, plus 'user' if logged in,
3590 * '*' for all accounts, and autopromoted groups
3591 * @param bool $recache Whether to avoid the cache
3592 * @return array Array of String internal group names
3594 public function getEffectiveGroups( $recache = false ) {
3595 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3596 $this->mEffectiveGroups
= array_unique( array_merge(
3597 $this->getGroups(), // explicit groups
3598 $this->getAutomaticGroups( $recache ) // implicit groups
3600 // Avoid PHP 7.1 warning of passing $this by reference
3602 // Hook for additional groups
3603 Hooks
::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups
] );
3604 // Force reindexation of groups when a hook has unset one of them
3605 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3607 return $this->mEffectiveGroups
;
3611 * Get the list of implicit group memberships this user has.
3612 * This includes 'user' if logged in, '*' for all accounts,
3613 * and autopromoted groups
3614 * @param bool $recache Whether to avoid the cache
3615 * @return array Array of String internal group names
3617 public function getAutomaticGroups( $recache = false ) {
3618 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3619 $this->mImplicitGroups
= [ '*' ];
3620 if ( $this->getId() ) {
3621 $this->mImplicitGroups
[] = 'user';
3623 $this->mImplicitGroups
= array_unique( array_merge(
3624 $this->mImplicitGroups
,
3625 Autopromote
::getAutopromoteGroups( $this )
3629 // Assure data consistency with rights/groups,
3630 // as getEffectiveGroups() depends on this function
3631 $this->mEffectiveGroups
= null;
3634 return $this->mImplicitGroups
;
3638 * Returns the groups the user has belonged to.
3640 * The user may still belong to the returned groups. Compare with getGroups().
3642 * The function will not return groups the user had belonged to before MW 1.17
3644 * @return array Names of the groups the user has belonged to.
3646 public function getFormerGroups() {
3649 if ( is_null( $this->mFormerGroups
) ) {
3650 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3651 ?
wfGetDB( DB_MASTER
)
3652 : wfGetDB( DB_REPLICA
);
3653 $res = $db->select( 'user_former_groups',
3655 [ 'ufg_user' => $this->mId
],
3657 $this->mFormerGroups
= [];
3658 foreach ( $res as $row ) {
3659 $this->mFormerGroups
[] = $row->ufg_group
;
3663 return $this->mFormerGroups
;
3667 * Get the user's edit count.
3668 * @return int|null Null for anonymous users
3670 public function getEditCount() {
3671 if ( !$this->getId() ) {
3675 if ( $this->mEditCount
=== null ) {
3676 /* Populate the count, if it has not been populated yet */
3677 $dbr = wfGetDB( DB_REPLICA
);
3678 // check if the user_editcount field has been initialized
3679 $count = $dbr->selectField(
3680 'user', 'user_editcount',
3681 [ 'user_id' => $this->mId
],
3685 if ( $count === null ) {
3686 // it has not been initialized. do so.
3687 $count = $this->initEditCount();
3689 $this->mEditCount
= $count;
3691 return (int)$this->mEditCount
;
3695 * Add the user to the given group. This takes immediate effect.
3696 * If the user is already in the group, the expiry time will be updated to the new
3697 * expiry time. (If $expiry is omitted or null, the membership will be altered to
3700 * @param string $group Name of the group to add
3701 * @param string|null $expiry Optional expiry timestamp in any format acceptable to
3702 * wfTimestamp(), or null if the group assignment should not expire
3705 public function addGroup( $group, $expiry = null ) {
3707 $this->loadGroups();
3710 $expiry = wfTimestamp( TS_MW
, $expiry );
3713 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
3717 // create the new UserGroupMembership and put it in the DB
3718 $ugm = new UserGroupMembership( $this->mId
, $group, $expiry );
3719 if ( !$ugm->insert( true ) ) {
3723 $this->mGroupMemberships
[$group] = $ugm;
3725 // Refresh the groups caches, and clear the rights cache so it will be
3726 // refreshed on the next call to $this->getRights().
3727 $this->getEffectiveGroups( true );
3728 $this->mRights
= null;
3730 $this->invalidateCache();
3736 * Remove the user from the given group.
3737 * This takes immediate effect.
3738 * @param string $group Name of the group to remove
3741 public function removeGroup( $group ) {
3744 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3748 $ugm = UserGroupMembership
::getMembership( $this->mId
, $group );
3749 // delete the membership entry
3750 if ( !$ugm ||
!$ugm->delete() ) {
3754 $this->loadGroups();
3755 unset( $this->mGroupMemberships
[$group] );
3757 // Refresh the groups caches, and clear the rights cache so it will be
3758 // refreshed on the next call to $this->getRights().
3759 $this->getEffectiveGroups( true );
3760 $this->mRights
= null;
3762 $this->invalidateCache();
3768 * Get whether the user is logged in
3771 public function isLoggedIn() {
3772 return $this->getId() != 0;
3776 * Get whether the user is anonymous
3779 public function isAnon() {
3780 return !$this->isLoggedIn();
3784 * @return bool Whether this user is flagged as being a bot role account
3787 public function isBot() {
3788 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3793 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3799 * Check if user is allowed to access a feature / make an action
3801 * @param string $permissions,... Permissions to test
3802 * @return bool True if user is allowed to perform *any* of the given actions
3804 public function isAllowedAny() {
3805 $permissions = func_get_args();
3806 foreach ( $permissions as $permission ) {
3807 if ( $this->isAllowed( $permission ) ) {
3816 * @param string $permissions,... Permissions to test
3817 * @return bool True if the user is allowed to perform *all* of the given actions
3819 public function isAllowedAll() {
3820 $permissions = func_get_args();
3821 foreach ( $permissions as $permission ) {
3822 if ( !$this->isAllowed( $permission ) ) {
3830 * Internal mechanics of testing a permission
3831 * @param string $action
3834 public function isAllowed( $action = '' ) {
3835 if ( $action === '' ) {
3836 return true; // In the spirit of DWIM
3838 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3839 // by misconfiguration: 0 == 'foo'
3840 return in_array( $action, $this->getRights(), true );
3844 * Check whether to enable recent changes patrol features for this user
3845 * @return bool True or false
3847 public function useRCPatrol() {
3848 global $wgUseRCPatrol;
3849 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3853 * Check whether to enable new pages patrol features for this user
3854 * @return bool True or false
3856 public function useNPPatrol() {
3857 global $wgUseRCPatrol, $wgUseNPPatrol;
3859 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3860 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3865 * Check whether to enable new files patrol features for this user
3866 * @return bool True or false
3868 public function useFilePatrol() {
3869 global $wgUseRCPatrol, $wgUseFilePatrol;
3871 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3872 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3877 * Get the WebRequest object to use with this object
3879 * @return WebRequest
3881 public function getRequest() {
3882 if ( $this->mRequest
) {
3883 return $this->mRequest
;
3891 * Check the watched status of an article.
3892 * @since 1.22 $checkRights parameter added
3893 * @param Title $title Title of the article to look at
3894 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3895 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3898 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3899 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3900 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3907 * @since 1.22 $checkRights parameter added
3908 * @param Title $title Title of the article to look at
3909 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3910 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3912 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3913 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3914 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3916 [ $title->getSubjectPage(), $title->getTalkPage() ]
3919 $this->invalidateCache();
3923 * Stop watching an article.
3924 * @since 1.22 $checkRights parameter added
3925 * @param Title $title Title of the article to look at
3926 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3927 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3929 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3930 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3931 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3932 $store->removeWatch( $this, $title->getSubjectPage() );
3933 $store->removeWatch( $this, $title->getTalkPage() );
3935 $this->invalidateCache();
3939 * Clear the user's notification timestamp for the given title.
3940 * If e-notif e-mails are on, they will receive notification mails on
3941 * the next change of the page if it's watched etc.
3942 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3943 * @param Title &$title Title of the article to look at
3944 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3946 public function clearNotification( &$title, $oldid = 0 ) {
3947 global $wgUseEnotif, $wgShowUpdatedMarker;
3949 // Do nothing if the database is locked to writes
3950 if ( wfReadOnly() ) {
3954 // Do nothing if not allowed to edit the watchlist
3955 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3959 // If we're working on user's talk page, we should update the talk page message indicator
3960 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3961 // Avoid PHP 7.1 warning of passing $this by reference
3963 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
3967 // Try to update the DB post-send and only if needed...
3968 DeferredUpdates
::addCallableUpdate( function () use ( $title, $oldid ) {
3969 if ( !$this->getNewtalk() ) {
3970 return; // no notifications to clear
3973 // Delete the last notifications (they stack up)
3974 $this->setNewtalk( false );
3976 // If there is a new, unseen, revision, use its timestamp
3978 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
3981 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
3986 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3990 if ( $this->isAnon() ) {
3991 // Nothing else to do...
3995 // Only update the timestamp if the page is being watched.
3996 // The query to find out if it is watched is cached both in memcached and per-invocation,
3997 // and when it does have to be executed, it can be on a replica DB
3998 // If this is the user's newtalk page, we always update the timestamp
4000 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
4004 MediaWikiServices
::getInstance()->getWatchedItemStore()
4005 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
4009 * Resets all of the given user's page-change notification timestamps.
4010 * If e-notif e-mails are on, they will receive notification mails on
4011 * the next change of any watched page.
4012 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
4014 public function clearAllNotifications() {
4015 global $wgUseEnotif, $wgShowUpdatedMarker;
4016 // Do nothing if not allowed to edit the watchlist
4017 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
4021 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4022 $this->setNewtalk( false );
4026 $id = $this->getId();
4031 $watchedItemStore = MediaWikiServices
::getInstance()->getWatchedItemStore();
4032 $watchedItemStore->resetAllNotificationTimestampsForUser( $this );
4034 // We also need to clear here the "you have new message" notification for the own
4035 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
4039 * Compute experienced level based on edit count and registration date.
4041 * @return string 'newcomer', 'learner', or 'experienced'
4043 public function getExperienceLevel() {
4044 global $wgLearnerEdits,
4045 $wgExperiencedUserEdits,
4046 $wgLearnerMemberSince,
4047 $wgExperiencedUserMemberSince;
4049 if ( $this->isAnon() ) {
4053 $editCount = $this->getEditCount();
4054 $registration = $this->getRegistration();
4056 $learnerRegistration = wfTimestamp( TS_MW
, $now - $wgLearnerMemberSince * 86400 );
4057 $experiencedRegistration = wfTimestamp( TS_MW
, $now - $wgExperiencedUserMemberSince * 86400 );
4060 $editCount < $wgLearnerEdits ||
4061 $registration > $learnerRegistration
4065 $editCount > $wgExperiencedUserEdits &&
4066 $registration <= $experiencedRegistration
4068 return 'experienced';
4075 * Persist this user's session (e.g. set cookies)
4077 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
4079 * @param bool|null $secure Whether to force secure/insecure cookies or use default
4080 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
4082 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
4084 if ( 0 == $this->mId
) {
4088 $session = $this->getRequest()->getSession();
4089 if ( $request && $session->getRequest() !== $request ) {
4090 $session = $session->sessionWithRequest( $request );
4092 $delay = $session->delaySave();
4094 if ( !$session->getUser()->equals( $this ) ) {
4095 if ( !$session->canSetUser() ) {
4096 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4097 ->warning( __METHOD__
.
4098 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
4102 $session->setUser( $this );
4105 $session->setRememberUser( $rememberMe );
4106 if ( $secure !== null ) {
4107 $session->setForceHTTPS( $secure );
4110 $session->persist();
4112 ScopedCallback
::consume( $delay );
4116 * Log this user out.
4118 public function logout() {
4119 // Avoid PHP 7.1 warning of passing $this by reference
4121 if ( Hooks
::run( 'UserLogout', [ &$user ] ) ) {
4127 * Clear the user's session, and reset the instance cache.
4130 public function doLogout() {
4131 $session = $this->getRequest()->getSession();
4132 if ( !$session->canSetUser() ) {
4133 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4134 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
4135 $error = 'immutable';
4136 } elseif ( !$session->getUser()->equals( $this ) ) {
4137 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4138 ->warning( __METHOD__
.
4139 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
4141 // But we still may as well make this user object anon
4142 $this->clearInstanceCache( 'defaults' );
4143 $error = 'wronguser';
4145 $this->clearInstanceCache( 'defaults' );
4146 $delay = $session->delaySave();
4147 $session->unpersist(); // Clear cookies (T127436)
4148 $session->setLoggedOutTimestamp( time() );
4149 $session->setUser( new User
);
4150 $session->set( 'wsUserID', 0 ); // Other code expects this
4151 $session->resetAllTokens();
4152 ScopedCallback
::consume( $delay );
4155 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
4156 'event' => 'logout',
4157 'successful' => $error === false,
4158 'status' => $error ?
: 'success',
4163 * Save this user's settings into the database.
4164 * @todo Only rarely do all these fields need to be set!
4166 public function saveSettings() {
4167 if ( wfReadOnly() ) {
4168 // @TODO: caller should deal with this instead!
4169 // This should really just be an exception.
4170 MWExceptionHandler
::logException( new DBExpectedError(
4172 "Could not update user with ID '{$this->mId}'; DB is read-only."
4178 if ( 0 == $this->mId
) {
4182 // Get a new user_touched that is higher than the old one.
4183 // This will be used for a CAS check as a last-resort safety
4184 // check against race conditions and replica DB lag.
4185 $newTouched = $this->newTouchedTimestamp();
4187 $dbw = wfGetDB( DB_MASTER
);
4188 $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $newTouched ) {
4189 global $wgActorTableSchemaMigrationStage;
4191 $dbw->update( 'user',
4193 'user_name' => $this->mName
,
4194 'user_real_name' => $this->mRealName
,
4195 'user_email' => $this->mEmail
,
4196 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4197 'user_touched' => $dbw->timestamp( $newTouched ),
4198 'user_token' => strval( $this->mToken
),
4199 'user_email_token' => $this->mEmailToken
,
4200 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
4201 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
4202 'user_id' => $this->mId
,
4206 if ( !$dbw->affectedRows() ) {
4207 // Maybe the problem was a missed cache update; clear it to be safe
4208 $this->clearSharedCache( 'refresh' );
4209 // User was changed in the meantime or loaded with stale data
4210 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
4211 throw new MWException(
4212 "CAS update failed on user_touched for user ID '{$this->mId}' (read from $from);" .
4213 " the version of the user to be saved is older than the current version."
4217 if ( $wgActorTableSchemaMigrationStage > MIGRATION_OLD
) {
4220 [ 'actor_name' => $this->mName
],
4221 [ 'actor_user' => $this->mId
],
4227 $this->mTouched
= $newTouched;
4228 $this->saveOptions();
4230 Hooks
::run( 'UserSaveSettings', [ $this ] );
4231 $this->clearSharedCache();
4232 $this->getUserPage()->invalidateCache();
4236 * If only this user's username is known, and it exists, return the user ID.
4238 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
4241 public function idForName( $flags = 0 ) {
4242 $s = trim( $this->getName() );
4247 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
4248 ?
wfGetDB( DB_MASTER
)
4249 : wfGetDB( DB_REPLICA
);
4251 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
4252 ?
[ 'LOCK IN SHARE MODE' ]
4255 $id = $db->selectField( 'user',
4256 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
4262 * Add a user to the database, return the user object
4264 * @param string $name Username to add
4265 * @param array $params Array of Strings Non-default parameters to save to
4266 * the database as user_* fields:
4267 * - email: The user's email address.
4268 * - email_authenticated: The email authentication timestamp.
4269 * - real_name: The user's real name.
4270 * - options: An associative array of non-default options.
4271 * - token: Random authentication token. Do not set.
4272 * - registration: Registration timestamp. Do not set.
4274 * @return User|null User object, or null if the username already exists.
4276 public static function createNew( $name, $params = [] ) {
4277 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
4278 if ( isset( $params[$field] ) ) {
4279 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
4280 unset( $params[$field] );
4286 $user->setToken(); // init token
4287 if ( isset( $params['options'] ) ) {
4288 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
4289 unset( $params['options'] );
4291 $dbw = wfGetDB( DB_MASTER
);
4293 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4296 'user_name' => $name,
4297 'user_password' => $noPass,
4298 'user_newpassword' => $noPass,
4299 'user_email' => $user->mEmail
,
4300 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
4301 'user_real_name' => $user->mRealName
,
4302 'user_token' => strval( $user->mToken
),
4303 'user_registration' => $dbw->timestamp( $user->mRegistration
),
4304 'user_editcount' => 0,
4305 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4307 foreach ( $params as $name => $value ) {
4308 $fields["user_$name"] = $value;
4311 return $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $fields ) {
4312 $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
4313 if ( $dbw->affectedRows() ) {
4314 $newUser = self
::newFromId( $dbw->insertId() );
4315 // Load the user from master to avoid replica lag
4316 $newUser->load( self
::READ_LATEST
);
4317 $newUser->updateActorId( $dbw );
4326 * Add this existing user object to the database. If the user already
4327 * exists, a fatal status object is returned, and the user object is
4328 * initialised with the data from the database.
4330 * Previously, this function generated a DB error due to a key conflict
4331 * if the user already existed. Many extension callers use this function
4332 * in code along the lines of:
4334 * $user = User::newFromName( $name );
4335 * if ( !$user->isLoggedIn() ) {
4336 * $user->addToDatabase();
4338 * // do something with $user...
4340 * However, this was vulnerable to a race condition (T18020). By
4341 * initialising the user object if the user exists, we aim to support this
4342 * calling sequence as far as possible.
4344 * Note that if the user exists, this function will acquire a write lock,
4345 * so it is still advisable to make the call conditional on isLoggedIn(),
4346 * and to commit the transaction after calling.
4348 * @throws MWException
4351 public function addToDatabase() {
4353 if ( !$this->mToken
) {
4354 $this->setToken(); // init token
4357 if ( !is_string( $this->mName
) ) {
4358 throw new RuntimeException( "User name field is not set." );
4361 $this->mTouched
= $this->newTouchedTimestamp();
4363 $dbw = wfGetDB( DB_MASTER
);
4364 $status = $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) {
4365 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4366 $dbw->insert( 'user',
4368 'user_name' => $this->mName
,
4369 'user_password' => $noPass,
4370 'user_newpassword' => $noPass,
4371 'user_email' => $this->mEmail
,
4372 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4373 'user_real_name' => $this->mRealName
,
4374 'user_token' => strval( $this->mToken
),
4375 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4376 'user_editcount' => 0,
4377 'user_touched' => $dbw->timestamp( $this->mTouched
),
4381 if ( !$dbw->affectedRows() ) {
4382 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4383 $this->mId
= $dbw->selectField(
4386 [ 'user_name' => $this->mName
],
4388 [ 'LOCK IN SHARE MODE' ]
4392 if ( $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4397 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
4398 "to insert user '{$this->mName}' row, but it was not present in select!" );
4400 return Status
::newFatal( 'userexists' );
4402 $this->mId
= $dbw->insertId();
4403 self
::$idCacheByName[$this->mName
] = $this->mId
;
4404 $this->updateActorId( $dbw );
4406 return Status
::newGood();
4408 if ( !$status->isGood() ) {
4412 // Clear instance cache other than user table data and actor, which is already accurate
4413 $this->clearInstanceCache();
4415 $this->saveOptions();
4416 return Status
::newGood();
4420 * Update the actor ID after an insert
4421 * @param IDatabase $dbw Writable database handle
4423 private function updateActorId( IDatabase
$dbw ) {
4424 global $wgActorTableSchemaMigrationStage;
4426 if ( $wgActorTableSchemaMigrationStage > MIGRATION_OLD
) {
4429 [ 'actor_user' => $this->mId
, 'actor_name' => $this->mName
],
4432 $this->mActorId
= (int)$dbw->insertId();
4437 * If this user is logged-in and blocked,
4438 * block any IP address they've successfully logged in from.
4439 * @return bool A block was spread
4441 public function spreadAnyEditBlock() {
4442 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4443 return $this->spreadBlock();
4450 * If this (non-anonymous) user is blocked,
4451 * block the IP address they've successfully logged in from.
4452 * @return bool A block was spread
4454 protected function spreadBlock() {
4455 wfDebug( __METHOD__
. "()\n" );
4457 if ( $this->mId
== 0 ) {
4461 $userblock = Block
::newFromTarget( $this->getName() );
4462 if ( !$userblock ) {
4466 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4470 * Get whether the user is explicitly blocked from account creation.
4471 * @return bool|Block
4473 public function isBlockedFromCreateAccount() {
4474 $this->getBlockedStatus();
4475 if ( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
4476 return $this->mBlock
;
4479 # T15611: if the IP address the user is trying to create an account from is
4480 # blocked with createaccount disabled, prevent new account creation there even
4481 # when the user is logged in
4482 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4483 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4485 return $this->mBlockedFromCreateAccount
instanceof Block
4486 && $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
4487 ?
$this->mBlockedFromCreateAccount
4492 * Get whether the user is blocked from using Special:Emailuser.
4495 public function isBlockedFromEmailuser() {
4496 $this->getBlockedStatus();
4497 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
4501 * Get whether the user is allowed to create an account.
4504 public function isAllowedToCreateAccount() {
4505 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4509 * Get this user's personal page title.
4511 * @return Title User's personal page title
4513 public function getUserPage() {
4514 return Title
::makeTitle( NS_USER
, $this->getName() );
4518 * Get this user's talk page title.
4520 * @return Title User's talk page title
4522 public function getTalkPage() {
4523 $title = $this->getUserPage();
4524 return $title->getTalkPage();
4528 * Determine whether the user is a newbie. Newbies are either
4529 * anonymous IPs, or the most recently created accounts.
4532 public function isNewbie() {
4533 return !$this->isAllowed( 'autoconfirmed' );
4537 * Check to see if the given clear-text password is one of the accepted passwords
4538 * @deprecated since 1.27, use AuthManager instead
4539 * @param string $password User password
4540 * @return bool True if the given password is correct, otherwise False
4542 public function checkPassword( $password ) {
4543 $manager = AuthManager
::singleton();
4544 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4545 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4547 'username' => $this->getName(),
4548 'password' => $password,
4551 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4552 switch ( $res->status
) {
4553 case AuthenticationResponse
::PASS
:
4555 case AuthenticationResponse
::FAIL
:
4556 // Hope it's not a PreAuthenticationProvider that failed...
4557 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4558 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4561 throw new BadMethodCallException(
4562 'AuthManager returned a response unsupported by ' . __METHOD__
4568 * Check if the given clear-text password matches the temporary password
4569 * sent by e-mail for password reset operations.
4571 * @deprecated since 1.27, use AuthManager instead
4572 * @param string $plaintext
4573 * @return bool True if matches, false otherwise
4575 public function checkTemporaryPassword( $plaintext ) {
4576 // Can't check the temporary password individually.
4577 return $this->checkPassword( $plaintext );
4581 * Initialize (if necessary) and return a session token value
4582 * which can be used in edit forms to show that the user's
4583 * login credentials aren't being hijacked with a foreign form
4587 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4588 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4589 * @return MediaWiki\Session\Token The new edit token
4591 public function getEditTokenObject( $salt = '', $request = null ) {
4592 if ( $this->isAnon() ) {
4593 return new LoggedOutEditToken();
4597 $request = $this->getRequest();
4599 return $request->getSession()->getToken( $salt );
4603 * Initialize (if necessary) and return a session token value
4604 * which can be used in edit forms to show that the user's
4605 * login credentials aren't being hijacked with a foreign form
4608 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4611 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4612 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4613 * @return string The new edit token
4615 public function getEditToken( $salt = '', $request = null ) {
4616 return $this->getEditTokenObject( $salt, $request )->toString();
4620 * Check given value against the token value stored in the session.
4621 * A match should confirm that the form was submitted from the
4622 * user's own login session, not a form submission from a third-party
4625 * @param string $val Input value to compare
4626 * @param string|array $salt Optional function-specific data for hashing
4627 * @param WebRequest|null $request Object to use or null to use $wgRequest
4628 * @param int|null $maxage Fail tokens older than this, in seconds
4629 * @return bool Whether the token matches
4631 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4632 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4636 * Check given value against the token value stored in the session,
4637 * ignoring the suffix.
4639 * @param string $val Input value to compare
4640 * @param string|array $salt Optional function-specific data for hashing
4641 * @param WebRequest|null $request Object to use or null to use $wgRequest
4642 * @param int|null $maxage Fail tokens older than this, in seconds
4643 * @return bool Whether the token matches
4645 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4646 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4647 return $this->matchEditToken( $val, $salt, $request, $maxage );
4651 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4652 * mail to the user's given address.
4654 * @param string $type Message to send, either "created", "changed" or "set"
4657 public function sendConfirmationMail( $type = 'created' ) {
4659 $expiration = null; // gets passed-by-ref and defined in next line.
4660 $token = $this->confirmationToken( $expiration );
4661 $url = $this->confirmationTokenUrl( $token );
4662 $invalidateURL = $this->invalidationTokenUrl( $token );
4663 $this->saveSettings();
4665 if ( $type == 'created' ||
$type === false ) {
4666 $message = 'confirmemail_body';
4667 } elseif ( $type === true ) {
4668 $message = 'confirmemail_body_changed';
4670 // Messages: confirmemail_body_changed, confirmemail_body_set
4671 $message = 'confirmemail_body_' . $type;
4674 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4675 wfMessage( $message,
4676 $this->getRequest()->getIP(),
4679 $wgLang->userTimeAndDate( $expiration, $this ),
4681 $wgLang->userDate( $expiration, $this ),
4682 $wgLang->userTime( $expiration, $this ) )->text() );
4686 * Send an e-mail to this user's account. Does not check for
4687 * confirmed status or validity.
4689 * @param string $subject Message subject
4690 * @param string $body Message body
4691 * @param User|null $from Optional sending user; if unspecified, default
4692 * $wgPasswordSender will be used.
4693 * @param string|null $replyto Reply-To address
4696 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4697 global $wgPasswordSender;
4699 if ( $from instanceof User
) {
4700 $sender = MailAddress
::newFromUser( $from );
4702 $sender = new MailAddress( $wgPasswordSender,
4703 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4705 $to = MailAddress
::newFromUser( $this );
4707 return UserMailer
::send( $to, $sender, $subject, $body, [
4708 'replyTo' => $replyto,
4713 * Generate, store, and return a new e-mail confirmation code.
4714 * A hash (unsalted, since it's used as a key) is stored.
4716 * @note Call saveSettings() after calling this function to commit
4717 * this change to the database.
4719 * @param string &$expiration Accepts the expiration time
4720 * @return string New token
4722 protected function confirmationToken( &$expiration ) {
4723 global $wgUserEmailConfirmationTokenExpiry;
4725 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4726 $expiration = wfTimestamp( TS_MW
, $expires );
4728 $token = MWCryptRand
::generateHex( 32 );
4729 $hash = md5( $token );
4730 $this->mEmailToken
= $hash;
4731 $this->mEmailTokenExpires
= $expiration;
4736 * Return a URL the user can use to confirm their email address.
4737 * @param string $token Accepts the email confirmation token
4738 * @return string New token URL
4740 protected function confirmationTokenUrl( $token ) {
4741 return $this->getTokenUrl( 'ConfirmEmail', $token );
4745 * Return a URL the user can use to invalidate their email address.
4746 * @param string $token Accepts the email confirmation token
4747 * @return string New token URL
4749 protected function invalidationTokenUrl( $token ) {
4750 return $this->getTokenUrl( 'InvalidateEmail', $token );
4754 * Internal function to format the e-mail validation/invalidation URLs.
4755 * This uses a quickie hack to use the
4756 * hardcoded English names of the Special: pages, for ASCII safety.
4758 * @note Since these URLs get dropped directly into emails, using the
4759 * short English names avoids insanely long URL-encoded links, which
4760 * also sometimes can get corrupted in some browsers/mailers
4761 * (T8957 with Gmail and Internet Explorer).
4763 * @param string $page Special page
4764 * @param string $token
4765 * @return string Formatted URL
4767 protected function getTokenUrl( $page, $token ) {
4768 // Hack to bypass localization of 'Special:'
4769 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4770 return $title->getCanonicalURL();
4774 * Mark the e-mail address confirmed.
4776 * @note Call saveSettings() after calling this function to commit the change.
4780 public function confirmEmail() {
4781 // Check if it's already confirmed, so we don't touch the database
4782 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4783 if ( !$this->isEmailConfirmed() ) {
4784 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4785 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4791 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4792 * address if it was already confirmed.
4794 * @note Call saveSettings() after calling this function to commit the change.
4795 * @return bool Returns true
4797 public function invalidateEmail() {
4799 $this->mEmailToken
= null;
4800 $this->mEmailTokenExpires
= null;
4801 $this->setEmailAuthenticationTimestamp( null );
4803 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4808 * Set the e-mail authentication timestamp.
4809 * @param string $timestamp TS_MW timestamp
4811 public function setEmailAuthenticationTimestamp( $timestamp ) {
4813 $this->mEmailAuthenticated
= $timestamp;
4814 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4818 * Is this user allowed to send e-mails within limits of current
4819 * site configuration?
4822 public function canSendEmail() {
4823 global $wgEnableEmail, $wgEnableUserEmail;
4824 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4827 $canSend = $this->isEmailConfirmed();
4828 // Avoid PHP 7.1 warning of passing $this by reference
4830 Hooks
::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
4835 * Is this user allowed to receive e-mails within limits of current
4836 * site configuration?
4839 public function canReceiveEmail() {
4840 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4844 * Is this user's e-mail address valid-looking and confirmed within
4845 * limits of the current site configuration?
4847 * @note If $wgEmailAuthentication is on, this may require the user to have
4848 * confirmed their address by returning a code or using a password
4849 * sent to the address from the wiki.
4853 public function isEmailConfirmed() {
4854 global $wgEmailAuthentication;
4856 // Avoid PHP 7.1 warning of passing $this by reference
4859 if ( Hooks
::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
4860 if ( $this->isAnon() ) {
4863 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4866 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4876 * Check whether there is an outstanding request for e-mail confirmation.
4879 public function isEmailConfirmationPending() {
4880 global $wgEmailAuthentication;
4881 return $wgEmailAuthentication &&
4882 !$this->isEmailConfirmed() &&
4883 $this->mEmailToken
&&
4884 $this->mEmailTokenExpires
> wfTimestamp();
4888 * Get the timestamp of account creation.
4890 * @return string|bool|null Timestamp of account creation, false for
4891 * non-existent/anonymous user accounts, or null if existing account
4892 * but information is not in database.
4894 public function getRegistration() {
4895 if ( $this->isAnon() ) {
4899 return $this->mRegistration
;
4903 * Get the timestamp of the first edit
4905 * @return string|bool Timestamp of first edit, or false for
4906 * non-existent/anonymous user accounts.
4908 public function getFirstEditTimestamp() {
4909 if ( $this->getId() == 0 ) {
4910 return false; // anons
4912 $dbr = wfGetDB( DB_REPLICA
);
4913 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
4914 $time = $dbr->selectField(
4915 [ 'revision' ] +
$actorWhere['tables'],
4917 [ $actorWhere['conds'] ],
4919 [ 'ORDER BY' => 'rev_timestamp ASC' ],
4920 $actorWhere['joins']
4923 return false; // no edits
4925 return wfTimestamp( TS_MW
, $time );
4929 * Get the permissions associated with a given list of groups
4931 * @param array $groups Array of Strings List of internal group names
4932 * @return array Array of Strings List of permission key names for given groups combined
4934 public static function getGroupPermissions( $groups ) {
4935 global $wgGroupPermissions, $wgRevokePermissions;
4937 // grant every granted permission first
4938 foreach ( $groups as $group ) {
4939 if ( isset( $wgGroupPermissions[$group] ) ) {
4940 $rights = array_merge( $rights,
4941 // array_filter removes empty items
4942 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4945 // now revoke the revoked permissions
4946 foreach ( $groups as $group ) {
4947 if ( isset( $wgRevokePermissions[$group] ) ) {
4948 $rights = array_diff( $rights,
4949 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4952 return array_unique( $rights );
4956 * Get all the groups who have a given permission
4958 * @param string $role Role to check
4959 * @return array Array of Strings List of internal group names with the given permission
4961 public static function getGroupsWithPermission( $role ) {
4962 global $wgGroupPermissions;
4963 $allowedGroups = [];
4964 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4965 if ( self
::groupHasPermission( $group, $role ) ) {
4966 $allowedGroups[] = $group;
4969 return $allowedGroups;
4973 * Check, if the given group has the given permission
4975 * If you're wanting to check whether all users have a permission, use
4976 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4980 * @param string $group Group to check
4981 * @param string $role Role to check
4984 public static function groupHasPermission( $group, $role ) {
4985 global $wgGroupPermissions, $wgRevokePermissions;
4986 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4987 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4991 * Check if all users may be assumed to have the given permission
4993 * We generally assume so if the right is granted to '*' and isn't revoked
4994 * on any group. It doesn't attempt to take grants or other extension
4995 * limitations on rights into account in the general case, though, as that
4996 * would require it to always return false and defeat the purpose.
4997 * Specifically, session-based rights restrictions (such as OAuth or bot
4998 * passwords) are applied based on the current session.
5001 * @param string $right Right to check
5004 public static function isEveryoneAllowed( $right ) {
5005 global $wgGroupPermissions, $wgRevokePermissions;
5008 // Use the cached results, except in unit tests which rely on
5009 // being able change the permission mid-request
5010 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
5011 return $cache[$right];
5014 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
5015 $cache[$right] = false;
5019 // If it's revoked anywhere, then everyone doesn't have it
5020 foreach ( $wgRevokePermissions as $rights ) {
5021 if ( isset( $rights[$right] ) && $rights[$right] ) {
5022 $cache[$right] = false;
5027 // Remove any rights that aren't allowed to the global-session user,
5028 // unless there are no sessions for this endpoint.
5029 if ( !defined( 'MW_NO_SESSION' ) ) {
5030 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
5031 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
5032 $cache[$right] = false;
5037 // Allow extensions to say false
5038 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
5039 $cache[$right] = false;
5043 $cache[$right] = true;
5048 * Get the localized descriptive name for a group, if it exists
5049 * @deprecated since 1.29 Use UserGroupMembership::getGroupName instead
5051 * @param string $group Internal group name
5052 * @return string Localized descriptive group name
5054 public static function getGroupName( $group ) {
5055 wfDeprecated( __METHOD__
, '1.29' );
5056 return UserGroupMembership
::getGroupName( $group );
5060 * Get the localized descriptive name for a member of a group, if it exists
5061 * @deprecated since 1.29 Use UserGroupMembership::getGroupMemberName instead
5063 * @param string $group Internal group name
5064 * @param string $username Username for gender (since 1.19)
5065 * @return string Localized name for group member
5067 public static function getGroupMember( $group, $username = '#' ) {
5068 wfDeprecated( __METHOD__
, '1.29' );
5069 return UserGroupMembership
::getGroupMemberName( $group, $username );
5073 * Return the set of defined explicit groups.
5074 * The implicit groups (by default *, 'user' and 'autoconfirmed')
5075 * are not included, as they are defined automatically, not in the database.
5076 * @return array Array of internal group names
5078 public static function getAllGroups() {
5079 global $wgGroupPermissions, $wgRevokePermissions;
5080 return array_values( array_diff(
5081 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
5082 self
::getImplicitGroups()
5087 * Get a list of all available permissions.
5088 * @return string[] Array of permission names
5090 public static function getAllRights() {
5091 if ( self
::$mAllRights === false ) {
5092 global $wgAvailableRights;
5093 if ( count( $wgAvailableRights ) ) {
5094 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
5096 self
::$mAllRights = self
::$mCoreRights;
5098 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
5100 return self
::$mAllRights;
5104 * Get a list of implicit groups
5105 * @return array Array of Strings Array of internal group names
5107 public static function getImplicitGroups() {
5108 global $wgImplicitGroups;
5110 $groups = $wgImplicitGroups;
5111 # Deprecated, use $wgImplicitGroups instead
5112 Hooks
::run( 'UserGetImplicitGroups', [ &$groups ], '1.25' );
5118 * Get the title of a page describing a particular group
5119 * @deprecated since 1.29 Use UserGroupMembership::getGroupPage instead
5121 * @param string $group Internal group name
5122 * @return Title|bool Title of the page if it exists, false otherwise
5124 public static function getGroupPage( $group ) {
5125 wfDeprecated( __METHOD__
, '1.29' );
5126 return UserGroupMembership
::getGroupPage( $group );
5130 * Create a link to the group in HTML, if available;
5131 * else return the group name.
5132 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5133 * make the link yourself if you need custom text
5135 * @param string $group Internal name of the group
5136 * @param string $text The text of the link
5137 * @return string HTML link to the group
5139 public static function makeGroupLinkHTML( $group, $text = '' ) {
5140 wfDeprecated( __METHOD__
, '1.29' );
5142 if ( $text == '' ) {
5143 $text = UserGroupMembership
::getGroupName( $group );
5145 $title = UserGroupMembership
::getGroupPage( $group );
5147 return MediaWikiServices
::getInstance()
5148 ->getLinkRenderer()->makeLink( $title, $text );
5150 return htmlspecialchars( $text );
5155 * Create a link to the group in Wikitext, if available;
5156 * else return the group name.
5157 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5158 * make the link yourself if you need custom text
5160 * @param string $group Internal name of the group
5161 * @param string $text The text of the link
5162 * @return string Wikilink to the group
5164 public static function makeGroupLinkWiki( $group, $text = '' ) {
5165 wfDeprecated( __METHOD__
, '1.29' );
5167 if ( $text == '' ) {
5168 $text = UserGroupMembership
::getGroupName( $group );
5170 $title = UserGroupMembership
::getGroupPage( $group );
5172 $page = $title->getFullText();
5173 return "[[$page|$text]]";
5180 * Returns an array of the groups that a particular group can add/remove.
5182 * @param string $group The group to check for whether it can add/remove
5183 * @return array Array( 'add' => array( addablegroups ),
5184 * 'remove' => array( removablegroups ),
5185 * 'add-self' => array( addablegroups to self),
5186 * 'remove-self' => array( removable groups from self) )
5188 public static function changeableByGroup( $group ) {
5189 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
5198 if ( empty( $wgAddGroups[$group] ) ) {
5199 // Don't add anything to $groups
5200 } elseif ( $wgAddGroups[$group] === true ) {
5201 // You get everything
5202 $groups['add'] = self
::getAllGroups();
5203 } elseif ( is_array( $wgAddGroups[$group] ) ) {
5204 $groups['add'] = $wgAddGroups[$group];
5207 // Same thing for remove
5208 if ( empty( $wgRemoveGroups[$group] ) ) {
5210 } elseif ( $wgRemoveGroups[$group] === true ) {
5211 $groups['remove'] = self
::getAllGroups();
5212 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
5213 $groups['remove'] = $wgRemoveGroups[$group];
5216 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
5217 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
5218 foreach ( $wgGroupsAddToSelf as $key => $value ) {
5219 if ( is_int( $key ) ) {
5220 $wgGroupsAddToSelf['user'][] = $value;
5225 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
5226 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
5227 if ( is_int( $key ) ) {
5228 $wgGroupsRemoveFromSelf['user'][] = $value;
5233 // Now figure out what groups the user can add to him/herself
5234 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
5236 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
5237 // No idea WHY this would be used, but it's there
5238 $groups['add-self'] = self
::getAllGroups();
5239 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
5240 $groups['add-self'] = $wgGroupsAddToSelf[$group];
5243 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
5245 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
5246 $groups['remove-self'] = self
::getAllGroups();
5247 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
5248 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
5255 * Returns an array of groups that this user can add and remove
5256 * @return array Array( 'add' => array( addablegroups ),
5257 * 'remove' => array( removablegroups ),
5258 * 'add-self' => array( addablegroups to self),
5259 * 'remove-self' => array( removable groups from self) )
5261 public function changeableGroups() {
5262 if ( $this->isAllowed( 'userrights' ) ) {
5263 // This group gives the right to modify everything (reverse-
5264 // compatibility with old "userrights lets you change
5266 // Using array_merge to make the groups reindexed
5267 $all = array_merge( self
::getAllGroups() );
5276 // Okay, it's not so simple, we will have to go through the arrays
5283 $addergroups = $this->getEffectiveGroups();
5285 foreach ( $addergroups as $addergroup ) {
5286 $groups = array_merge_recursive(
5287 $groups, $this->changeableByGroup( $addergroup )
5289 $groups['add'] = array_unique( $groups['add'] );
5290 $groups['remove'] = array_unique( $groups['remove'] );
5291 $groups['add-self'] = array_unique( $groups['add-self'] );
5292 $groups['remove-self'] = array_unique( $groups['remove-self'] );
5298 * Deferred version of incEditCountImmediate()
5300 * This function, rather than incEditCountImmediate(), should be used for
5301 * most cases as it avoids potential deadlocks caused by concurrent editing.
5303 public function incEditCount() {
5304 wfGetDB( DB_MASTER
)->onTransactionPreCommitOrIdle(
5306 $this->incEditCountImmediate();
5313 * Increment the user's edit-count field.
5314 * Will have no effect for anonymous users.
5317 public function incEditCountImmediate() {
5318 if ( $this->isAnon() ) {
5322 $dbw = wfGetDB( DB_MASTER
);
5323 // No rows will be "affected" if user_editcount is NULL
5326 [ 'user_editcount=user_editcount+1' ],
5327 [ 'user_id' => $this->getId(), 'user_editcount IS NOT NULL' ],
5330 // Lazy initialization check...
5331 if ( $dbw->affectedRows() == 0 ) {
5332 // Now here's a goddamn hack...
5333 $dbr = wfGetDB( DB_REPLICA
);
5334 if ( $dbr !== $dbw ) {
5335 // If we actually have a replica DB server, the count is
5336 // at least one behind because the current transaction
5337 // has not been committed and replicated.
5338 $this->mEditCount
= $this->initEditCount( 1 );
5340 // But if DB_REPLICA is selecting the master, then the
5341 // count we just read includes the revision that was
5342 // just added in the working transaction.
5343 $this->mEditCount
= $this->initEditCount();
5346 if ( $this->mEditCount
=== null ) {
5347 $this->getEditCount();
5348 $dbr = wfGetDB( DB_REPLICA
);
5349 $this->mEditCount +
= ( $dbr !== $dbw ) ?
1 : 0;
5351 $this->mEditCount++
;
5354 // Edit count in user cache too
5355 $this->invalidateCache();
5359 * Initialize user_editcount from data out of the revision table
5361 * @param int $add Edits to add to the count from the revision table
5362 * @return int Number of edits
5364 protected function initEditCount( $add = 0 ) {
5365 // Pull from a replica DB to be less cruel to servers
5366 // Accuracy isn't the point anyway here
5367 $dbr = wfGetDB( DB_REPLICA
);
5368 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5369 $count = (int)$dbr->selectField(
5370 [ 'revision' ] +
$actorWhere['tables'],
5372 [ $actorWhere['conds'] ],
5375 $actorWhere['joins']
5377 $count = $count +
$add;
5379 $dbw = wfGetDB( DB_MASTER
);
5382 [ 'user_editcount' => $count ],
5383 [ 'user_id' => $this->getId() ],
5391 * Get the description of a given right
5394 * @param string $right Right to query
5395 * @return string Localized description of the right
5397 public static function getRightDescription( $right ) {
5398 $key = "right-$right";
5399 $msg = wfMessage( $key );
5400 return $msg->isDisabled() ?
$right : $msg->text();
5404 * Get the name of a given grant
5407 * @param string $grant Grant to query
5408 * @return string Localized name of the grant
5410 public static function getGrantName( $grant ) {
5411 $key = "grant-$grant";
5412 $msg = wfMessage( $key );
5413 return $msg->isDisabled() ?
$grant : $msg->text();
5417 * Add a newuser log entry for this user.
5418 * Before 1.19 the return value was always true.
5420 * @deprecated since 1.27, AuthManager handles logging
5421 * @param string|bool $action Account creation type.
5422 * - String, one of the following values:
5423 * - 'create' for an anonymous user creating an account for himself.
5424 * This will force the action's performer to be the created user itself,
5425 * no matter the value of $wgUser
5426 * - 'create2' for a logged in user creating an account for someone else
5427 * - 'byemail' when the created user will receive its password by e-mail
5428 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5429 * - Boolean means whether the account was created by e-mail (deprecated):
5430 * - true will be converted to 'byemail'
5431 * - false will be converted to 'create' if this object is the same as
5432 * $wgUser and to 'create2' otherwise
5433 * @param string $reason User supplied reason
5436 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5437 return true; // disabled
5441 * Add an autocreate newuser log entry for this user
5442 * Used by things like CentralAuth and perhaps other authplugins.
5443 * Consider calling addNewUserLogEntry() directly instead.
5445 * @deprecated since 1.27, AuthManager handles logging
5448 public function addNewUserLogEntryAutoCreate() {
5449 $this->addNewUserLogEntry( 'autocreate' );
5455 * Load the user options either from cache, the database or an array
5457 * @param array|null $data Rows for the current user out of the user_properties table
5459 protected function loadOptions( $data = null ) {
5462 if ( $this->mOptionsLoaded
) {
5466 $this->mOptions
= self
::getDefaultOptions();
5468 if ( !$this->getId() ) {
5469 // For unlogged-in users, load language/variant options from request.
5470 // There's no need to do it for logged-in users: they can set preferences,
5471 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5472 // so don't override user's choice (especially when the user chooses site default).
5473 $variant = MediaWikiServices
::getInstance()->getContentLanguage()->getDefaultVariant();
5474 $this->mOptions
['variant'] = $variant;
5475 $this->mOptions
['language'] = $variant;
5476 $this->mOptionsLoaded
= true;
5480 // Maybe load from the object
5481 if ( !is_null( $this->mOptionOverrides
) ) {
5482 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5483 foreach ( $this->mOptionOverrides
as $key => $value ) {
5484 $this->mOptions
[$key] = $value;
5487 if ( !is_array( $data ) ) {
5488 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5489 // Load from database
5490 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5491 ?
wfGetDB( DB_MASTER
)
5492 : wfGetDB( DB_REPLICA
);
5494 $res = $dbr->select(
5496 [ 'up_property', 'up_value' ],
5497 [ 'up_user' => $this->getId() ],
5501 $this->mOptionOverrides
= [];
5503 foreach ( $res as $row ) {
5504 // Convert '0' to 0. PHP's boolean conversion considers them both
5505 // false, but e.g. JavaScript considers the former as true.
5506 // @todo: T54542 Somehow determine the desired type (string/int/bool)
5507 // and convert all values here.
5508 if ( $row->up_value
=== '0' ) {
5511 $data[$row->up_property
] = $row->up_value
;
5515 foreach ( $data as $property => $value ) {
5516 $this->mOptionOverrides
[$property] = $value;
5517 $this->mOptions
[$property] = $value;
5521 // Replace deprecated language codes
5522 $this->mOptions
['language'] = LanguageCode
::replaceDeprecatedCodes(
5523 $this->mOptions
['language']
5526 $this->mOptionsLoaded
= true;
5528 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5532 * Saves the non-default options for this user, as previously set e.g. via
5533 * setOption(), in the database's "user_properties" (preferences) table.
5534 * Usually used via saveSettings().
5536 protected function saveOptions() {
5537 $this->loadOptions();
5539 // Not using getOptions(), to keep hidden preferences in database
5540 $saveOptions = $this->mOptions
;
5542 // Allow hooks to abort, for instance to save to a global profile.
5543 // Reset options to default state before saving.
5544 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5548 $userId = $this->getId();
5550 $insert_rows = []; // all the new preference rows
5551 foreach ( $saveOptions as $key => $value ) {
5552 // Don't bother storing default values
5553 $defaultOption = self
::getDefaultOption( $key );
5554 if ( ( $defaultOption === null && $value !== false && $value !== null )
5555 ||
$value != $defaultOption
5558 'up_user' => $userId,
5559 'up_property' => $key,
5560 'up_value' => $value,
5565 $dbw = wfGetDB( DB_MASTER
);
5567 $res = $dbw->select( 'user_properties',
5568 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5570 // Find prior rows that need to be removed or updated. These rows will
5571 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5573 foreach ( $res as $row ) {
5574 if ( !isset( $saveOptions[$row->up_property
] )
5575 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5577 $keysDelete[] = $row->up_property
;
5581 if ( count( $keysDelete ) ) {
5582 // Do the DELETE by PRIMARY KEY for prior rows.
5583 // In the past a very large portion of calls to this function are for setting
5584 // 'rememberpassword' for new accounts (a preference that has since been removed).
5585 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5586 // caused gap locks on [max user ID,+infinity) which caused high contention since
5587 // updates would pile up on each other as they are for higher (newer) user IDs.
5588 // It might not be necessary these days, but it shouldn't hurt either.
5589 $dbw->delete( 'user_properties',
5590 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5592 // Insert the new preference rows
5593 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5597 * Return the list of user fields that should be selected to create
5598 * a new user object.
5599 * @deprecated since 1.31, use self::getQueryInfo() instead.
5602 public static function selectFields() {
5603 wfDeprecated( __METHOD__
, '1.31' );
5611 'user_email_authenticated',
5613 'user_email_token_expires',
5614 'user_registration',
5620 * Return the tables, fields, and join conditions to be selected to create
5621 * a new user object.
5623 * @return array With three keys:
5624 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
5625 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
5626 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
5628 public static function getQueryInfo() {
5629 global $wgActorTableSchemaMigrationStage;
5632 'tables' => [ 'user' ],
5640 'user_email_authenticated',
5642 'user_email_token_expires',
5643 'user_registration',
5648 if ( $wgActorTableSchemaMigrationStage > MIGRATION_OLD
) {
5649 $ret['tables']['user_actor'] = 'actor';
5650 $ret['fields'][] = 'user_actor.actor_id';
5651 $ret['joins']['user_actor'] = [
5652 $wgActorTableSchemaMigrationStage === MIGRATION_NEW ?
'JOIN' : 'LEFT JOIN',
5653 [ 'user_actor.actor_user = user_id' ]
5660 * Factory function for fatal permission-denied errors
5663 * @param string $permission User right required
5666 static function newFatalPermissionDeniedStatus( $permission ) {
5670 foreach ( self
::getGroupsWithPermission( $permission ) as $group ) {
5671 $groups[] = UserGroupMembership
::getLink( $group, RequestContext
::getMain(), 'wiki' );
5675 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5677 return Status
::newFatal( 'badaccess-group0' );
5682 * Get a new instance of this user that was loaded from the master via a locking read
5684 * Use this instead of the main context User when updating that user. This avoids races
5685 * where that user was loaded from a replica DB or even the master but without proper locks.
5687 * @return User|null Returns null if the user was not found in the DB
5690 public function getInstanceForUpdate() {
5691 if ( !$this->getId() ) {
5692 return null; // anon
5695 $user = self
::newFromId( $this->getId() );
5696 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5704 * Checks if two user objects point to the same user.
5706 * @since 1.25 ; takes a UserIdentity instead of a User since 1.32
5707 * @param UserIdentity $user
5710 public function equals( UserIdentity
$user ) {
5711 // XXX it's not clear whether central ID providers are supposed to obey this
5712 return $this->getName() === $user->getName();