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 * String Some punctuation to prevent editing from broken text-mangling proxies.
38 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
41 define( 'EDIT_TOKEN_SUFFIX', Token
::SUFFIX
);
44 * The User object encapsulates all of the user-specific settings (user_id,
45 * name, rights, email address, options, last login time). Client
46 * classes use the getXXX() functions to access these fields. These functions
47 * do all the work of determining whether the user is logged in,
48 * whether the requested option can be satisfied from cookies or
49 * whether a database query is needed. Most of the settings needed
50 * for rendering normal pages are set in the cookie to minimize use
53 class User
implements IDBAccessObject
, UserIdentity
{
55 * @const int Number of characters in user_token field.
57 const TOKEN_LENGTH
= 32;
60 * @const string An invalid value for user_token
62 const INVALID_TOKEN
= '*** INVALID ***';
65 * Global constant made accessible as class constants so that autoloader
67 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
69 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
72 * @const int Serialized record version.
77 * Exclude user options that are set to their default value.
80 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
85 const CHECK_USER_RIGHTS
= true;
90 const IGNORE_USER_RIGHTS
= false;
93 * Array of Strings List of member variables which are saved to the
94 * shared cache (memcached). Any operation which changes the
95 * corresponding database fields must call a cache-clearing function.
98 protected static $mCacheVars = [
106 'mEmailAuthenticated',
108 'mEmailTokenExpires',
113 // user_properties table
120 * Array of Strings Core rights.
121 * Each of these should have a corresponding message of the form
125 protected static $mCoreRights = [
170 'move-categorypages',
171 'move-rootuserpages',
175 'override-export-depth',
197 'userrights-interwiki',
205 * String Cached results of getAllRights()
207 protected static $mAllRights = false;
209 /** Cache variables */
222 /** @var string TS_MW timestamp from the DB */
224 /** @var string TS_MW timestamp from cache */
225 protected $mQuickTouched;
229 public $mEmailAuthenticated;
231 protected $mEmailToken;
233 protected $mEmailTokenExpires;
235 protected $mRegistration;
237 protected $mEditCount;
238 /** @var UserGroupMembership[] Associative array of (group name => UserGroupMembership object) */
239 protected $mGroupMemberships;
241 protected $mOptionOverrides;
245 * Bool Whether the cache variables have been loaded.
248 public $mOptionsLoaded;
251 * Array with already loaded items or true if all items have been loaded.
253 protected $mLoadedItems = [];
257 * String Initialization data source if mLoadedItems!==true. May be one of:
258 * - 'defaults' anonymous user initialised from class defaults
259 * - 'name' initialise from mName
260 * - 'id' initialise from mId
261 * - 'actor' initialise from mActorId
262 * - 'session' log in from session if possible
264 * Use the User::newFrom*() family of functions to set this.
269 * Lazy-initialized variables, invalidated with clearInstanceCache
273 protected $mDatePreference;
281 protected $mBlockreason;
283 protected $mEffectiveGroups;
285 protected $mImplicitGroups;
287 protected $mFormerGroups;
289 protected $mGlobalBlock;
297 /** @var WebRequest */
304 protected $mAllowUsertalk;
307 private $mBlockedFromCreateAccount = false;
309 /** @var int User::READ_* constant bitfield used to load data */
310 protected $queryFlagsUsed = self
::READ_NORMAL
;
312 public static $idCacheByName = [];
315 * Lightweight constructor for an anonymous user.
316 * Use the User::newFrom* factory functions for other kinds of users.
320 * @see newFromActorId()
321 * @see newFromConfirmationCode()
322 * @see newFromSession()
325 public function __construct() {
326 $this->clearInstanceCache( 'defaults' );
332 public function __toString() {
333 return (string)$this->getName();
337 * Test if it's safe to load this User object.
339 * You should typically check this before using $wgUser or
340 * RequestContext::getUser in a method that might be called before the
341 * system has been fully initialized. If the object is unsafe, you should
342 * use an anonymous user:
344 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
350 public function isSafeToLoad() {
351 global $wgFullyInitialised;
353 // The user is safe to load if:
354 // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
355 // * mLoadedItems === true (already loaded)
356 // * mFrom !== 'session' (sessions not involved at all)
358 return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
359 $this->mLoadedItems
=== true ||
$this->mFrom
!== 'session';
363 * Load the user table data for this object from the source given by mFrom.
365 * @param int $flags User::READ_* constant bitfield
367 public function load( $flags = self
::READ_NORMAL
) {
368 global $wgFullyInitialised;
370 if ( $this->mLoadedItems
=== true ) {
374 // Set it now to avoid infinite recursion in accessors
375 $oldLoadedItems = $this->mLoadedItems
;
376 $this->mLoadedItems
= true;
377 $this->queryFlagsUsed
= $flags;
379 // If this is called too early, things are likely to break.
380 if ( !$wgFullyInitialised && $this->mFrom
=== 'session' ) {
381 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
382 ->warning( 'User::loadFromSession called before the end of Setup.php', [
383 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
385 $this->loadDefaults();
386 $this->mLoadedItems
= $oldLoadedItems;
390 switch ( $this->mFrom
) {
392 $this->loadDefaults();
395 // Make sure this thread sees its own changes
396 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
397 if ( $lb->hasOrMadeRecentMasterChanges() ) {
398 $flags |
= self
::READ_LATEST
;
399 $this->queryFlagsUsed
= $flags;
402 $this->mId
= self
::idFromName( $this->mName
, $flags );
404 // Nonexistent user placeholder object
405 $this->loadDefaults( $this->mName
);
407 $this->loadFromId( $flags );
411 // Make sure this thread sees its own changes, if the ID isn't 0
412 if ( $this->mId
!= 0 ) {
413 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
414 if ( $lb->hasOrMadeRecentMasterChanges() ) {
415 $flags |
= self
::READ_LATEST
;
416 $this->queryFlagsUsed
= $flags;
420 $this->loadFromId( $flags );
423 // Make sure this thread sees its own changes
424 if ( wfGetLB()->hasOrMadeRecentMasterChanges() ) {
425 $flags |
= self
::READ_LATEST
;
426 $this->queryFlagsUsed
= $flags;
429 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
430 $row = wfGetDB( $index )->selectRow(
432 [ 'actor_user', 'actor_name' ],
433 [ 'actor_id' => $this->mActorId
],
440 $this->loadDefaults();
441 } elseif ( $row->actor_user
) {
442 $this->mId
= $row->actor_user
;
443 $this->loadFromId( $flags );
445 $this->loadDefaults( $row->actor_name
);
449 if ( !$this->loadFromSession() ) {
450 // Loading from session failed. Load defaults.
451 $this->loadDefaults();
453 Hooks
::run( 'UserLoadAfterLoadFromSession', [ $this ] );
456 throw new UnexpectedValueException(
457 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
462 * Load user table data, given mId has already been set.
463 * @param int $flags User::READ_* constant bitfield
464 * @return bool False if the ID does not exist, true otherwise
466 public function loadFromId( $flags = self
::READ_NORMAL
) {
467 if ( $this->mId
== 0 ) {
468 // Anonymous users are not in the database (don't need cache)
469 $this->loadDefaults();
473 // Try cache (unless this needs data from the master DB).
474 // NOTE: if this thread called saveSettings(), the cache was cleared.
475 $latest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
477 if ( !$this->loadFromDatabase( $flags ) ) {
478 // Can't load from ID
482 $this->loadFromCache();
485 $this->mLoadedItems
= true;
486 $this->queryFlagsUsed
= $flags;
493 * @param string $wikiId
496 public static function purge( $wikiId, $userId ) {
497 $cache = ObjectCache
::getMainWANInstance();
498 $key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
499 $cache->delete( $key );
504 * @param WANObjectCache $cache
507 protected function getCacheKey( WANObjectCache
$cache ) {
508 return $cache->makeGlobalKey( 'user', 'id', wfWikiID(), $this->mId
);
512 * @param WANObjectCache $cache
516 public function getMutableCacheKeys( WANObjectCache
$cache ) {
517 $id = $this->getId();
519 return $id ?
[ $this->getCacheKey( $cache ) ] : [];
523 * Load user data from shared cache, given mId has already been set.
528 protected function loadFromCache() {
529 $cache = ObjectCache
::getMainWANInstance();
530 $data = $cache->getWithSetCallback(
531 $this->getCacheKey( $cache ),
533 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
534 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
535 wfDebug( "User: cache miss for user {$this->mId}\n" );
537 $this->loadFromDatabase( self
::READ_NORMAL
);
539 $this->loadOptions();
542 foreach ( self
::$mCacheVars as $name ) {
543 $data[$name] = $this->$name;
546 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->mTouched
), $ttl );
548 // if a user group membership is about to expire, the cache needs to
549 // expire at that time (T163691)
550 foreach ( $this->mGroupMemberships
as $ugm ) {
551 if ( $ugm->getExpiry() ) {
552 $secondsUntilExpiry = wfTimestamp( TS_UNIX
, $ugm->getExpiry() ) - time();
553 if ( $secondsUntilExpiry > 0 && $secondsUntilExpiry < $ttl ) {
554 $ttl = $secondsUntilExpiry;
561 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'version' => self
::VERSION
]
564 // Restore from cache
565 foreach ( self
::$mCacheVars as $name ) {
566 $this->$name = $data[$name];
572 /** @name newFrom*() static factory methods */
576 * Static factory method for creation from username.
578 * This is slightly less efficient than newFromId(), so use newFromId() if
579 * you have both an ID and a name handy.
581 * @param string $name Username, validated by Title::newFromText()
582 * @param string|bool $validate Validate username. Takes the same parameters as
583 * User::getCanonicalName(), except that true is accepted as an alias
584 * for 'valid', for BC.
586 * @return User|bool User object, or false if the username is invalid
587 * (e.g. if it contains illegal characters or is an IP address). If the
588 * username is not present in the database, the result will be a user object
589 * with a name, zero user ID and default settings.
591 public static function newFromName( $name, $validate = 'valid' ) {
592 if ( $validate === true ) {
595 $name = self
::getCanonicalName( $name, $validate );
596 if ( $name === false ) {
599 // Create unloaded user object
603 $u->setItemLoaded( 'name' );
609 * Static factory method for creation from a given user ID.
611 * @param int $id Valid user ID
612 * @return User The corresponding User object
614 public static function newFromId( $id ) {
618 $u->setItemLoaded( 'id' );
623 * Static factory method for creation from a given actor ID.
626 * @param int $id Valid actor ID
627 * @return User The corresponding User object
629 public static function newFromActorId( $id ) {
630 global $wgActorTableSchemaMigrationStage;
632 if ( $wgActorTableSchemaMigrationStage <= MIGRATION_OLD
) {
633 throw new BadMethodCallException(
634 'Cannot use ' . __METHOD__
. ' when $wgActorTableSchemaMigrationStage is MIGRATION_OLD'
641 $u->setItemLoaded( 'actor' );
646 * Static factory method for creation from an ID, name, and/or actor ID
648 * This does not check that the ID, name, and actor ID all correspond to
652 * @param int|null $userId User ID, if known
653 * @param string|null $userName User name, if known
654 * @param int|null $actorId Actor ID, if known
657 public static function newFromAnyId( $userId, $userName, $actorId ) {
658 global $wgActorTableSchemaMigrationStage;
661 $user->mFrom
= 'defaults';
663 if ( $wgActorTableSchemaMigrationStage > MIGRATION_OLD
&& $actorId !== null ) {
664 $user->mActorId
= (int)$actorId;
665 if ( $user->mActorId
!== 0 ) {
666 $user->mFrom
= 'actor';
668 $user->setItemLoaded( 'actor' );
671 if ( $userName !== null && $userName !== '' ) {
672 $user->mName
= $userName;
673 $user->mFrom
= 'name';
674 $user->setItemLoaded( 'name' );
677 if ( $userId !== null ) {
678 $user->mId
= (int)$userId;
679 if ( $user->mId
!== 0 ) {
682 $user->setItemLoaded( 'id' );
685 if ( $user->mFrom
=== 'defaults' ) {
686 throw new InvalidArgumentException(
687 'Cannot create a user with no name, no ID, and no actor ID'
695 * Factory method to fetch whichever user has a given email confirmation code.
696 * This code is generated when an account is created or its e-mail address
699 * If the code is invalid or has expired, returns NULL.
701 * @param string $code Confirmation code
702 * @param int $flags User::READ_* bitfield
705 public static function newFromConfirmationCode( $code, $flags = 0 ) {
706 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
707 ?
wfGetDB( DB_MASTER
)
708 : wfGetDB( DB_REPLICA
);
710 $id = $db->selectField(
714 'user_email_token' => md5( $code ),
715 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
719 return $id ? self
::newFromId( $id ) : null;
723 * Create a new user object using data from session. If the login
724 * credentials are invalid, the result is an anonymous user.
726 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
729 public static function newFromSession( WebRequest
$request = null ) {
731 $user->mFrom
= 'session';
732 $user->mRequest
= $request;
737 * Create a new user object from a user row.
738 * The row should have the following fields from the user table in it:
739 * - either user_name or user_id to load further data if needed (or both)
741 * - all other fields (email, etc.)
742 * It is useless to provide the remaining fields if either user_id,
743 * user_name and user_real_name are not provided because the whole row
744 * will be loaded once more from the database when accessing them.
746 * @param stdClass $row A row from the user table
747 * @param array $data Further data to load into the object (see User::loadFromRow for valid keys)
750 public static function newFromRow( $row, $data = null ) {
752 $user->loadFromRow( $row, $data );
757 * Static factory method for creation of a "system" user from username.
759 * A "system" user is an account that's used to attribute logged actions
760 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
761 * might include the 'Maintenance script' or 'Conversion script' accounts
762 * used by various scripts in the maintenance/ directory or accounts such
763 * as 'MediaWiki message delivery' used by the MassMessage extension.
765 * This can optionally create the user if it doesn't exist, and "steal" the
766 * account if it does exist.
768 * "Stealing" an existing user is intended to make it impossible for normal
769 * authentication processes to use the account, effectively disabling the
770 * account for normal use:
771 * - Email is invalidated, to prevent account recovery by emailing a
772 * temporary password and to disassociate the account from the existing
774 * - The token is set to a magic invalid value, to kill existing sessions
775 * and to prevent $this->setToken() calls from resetting the token to a
777 * - SessionManager is instructed to prevent new sessions for the user, to
778 * do things like deauthorizing OAuth consumers.
779 * - AuthManager is instructed to revoke access, to invalidate or remove
780 * passwords and other credentials.
782 * @param string $name Username
783 * @param array $options Options are:
784 * - validate: As for User::getCanonicalName(), default 'valid'
785 * - create: Whether to create the user if it doesn't already exist, default true
786 * - steal: Whether to "disable" the account for normal use if it already
787 * exists, default false
791 public static function newSystemUser( $name, $options = [] ) {
793 'validate' => 'valid',
798 $name = self
::getCanonicalName( $name, $options['validate'] );
799 if ( $name === false ) {
803 $dbr = wfGetDB( DB_REPLICA
);
804 $userQuery = self
::getQueryInfo();
805 $row = $dbr->selectRow(
806 $userQuery['tables'],
807 $userQuery['fields'],
808 [ 'user_name' => $name ],
814 // Try the master database...
815 $dbw = wfGetDB( DB_MASTER
);
816 $row = $dbw->selectRow(
817 $userQuery['tables'],
818 $userQuery['fields'],
819 [ 'user_name' => $name ],
827 // No user. Create it?
828 return $options['create']
829 ? self
::createNew( $name, [ 'token' => self
::INVALID_TOKEN
] )
833 $user = self
::newFromRow( $row );
835 // A user is considered to exist as a non-system user if it can
836 // authenticate, or has an email set, or has a non-invalid token.
837 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
838 AuthManager
::singleton()->userCanAuthenticate( $name )
840 // User exists. Steal it?
841 if ( !$options['steal'] ) {
845 AuthManager
::singleton()->revokeAccessForUser( $name );
847 $user->invalidateEmail();
848 $user->mToken
= self
::INVALID_TOKEN
;
849 $user->saveSettings();
850 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
859 * Get the username corresponding to a given user ID
860 * @param int $id User ID
861 * @return string|bool The corresponding username
863 public static function whoIs( $id ) {
864 return UserCache
::singleton()->getProp( $id, 'name' );
868 * Get the real name of a user given their user ID
870 * @param int $id User ID
871 * @return string|bool The corresponding user's real name
873 public static function whoIsReal( $id ) {
874 return UserCache
::singleton()->getProp( $id, 'real_name' );
878 * Get database id given a user name
879 * @param string $name Username
880 * @param int $flags User::READ_* constant bitfield
881 * @return int|null The corresponding user's ID, or null if user is nonexistent
883 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
884 $nt = Title
::makeTitleSafe( NS_USER
, $name );
885 if ( is_null( $nt ) ) {
890 if ( !( $flags & self
::READ_LATEST
) && array_key_exists( $name, self
::$idCacheByName ) ) {
891 return self
::$idCacheByName[$name];
894 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
895 $db = wfGetDB( $index );
900 [ 'user_name' => $nt->getText() ],
905 if ( $s === false ) {
908 $result = $s->user_id
;
911 self
::$idCacheByName[$name] = $result;
913 if ( count( self
::$idCacheByName ) > 1000 ) {
914 self
::$idCacheByName = [];
921 * Reset the cache used in idFromName(). For use in tests.
923 public static function resetIdByNameCache() {
924 self
::$idCacheByName = [];
928 * Does the string match an anonymous IP address?
930 * This function exists for username validation, in order to reject
931 * usernames which are similar in form to IP addresses. Strings such
932 * as 300.300.300.300 will return true because it looks like an IP
933 * address, despite not being strictly valid.
935 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
936 * address because the usemod software would "cloak" anonymous IP
937 * addresses like this, if we allowed accounts like this to be created
938 * new users could get the old edits of these anonymous users.
940 * @param string $name Name to match
943 public static function isIP( $name ) {
944 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
945 || IP
::isIPv6( $name );
949 * Is the user an IP range?
954 public function isIPRange() {
955 return IP
::isValidRange( $this->mName
);
959 * Is the input a valid username?
961 * Checks if the input is a valid username, we don't want an empty string,
962 * an IP address, anything that contains slashes (would mess up subpages),
963 * is longer than the maximum allowed username size or doesn't begin with
966 * @param string $name Name to match
969 public static function isValidUserName( $name ) {
970 global $wgContLang, $wgMaxNameChars;
973 || self
::isIP( $name )
974 ||
strpos( $name, '/' ) !== false
975 ||
strlen( $name ) > $wgMaxNameChars
976 ||
$name != $wgContLang->ucfirst( $name )
981 // Ensure that the name can't be misresolved as a different title,
982 // such as with extra namespace keys at the start.
983 $parsed = Title
::newFromText( $name );
984 if ( is_null( $parsed )
985 ||
$parsed->getNamespace()
986 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
990 // Check an additional blacklist of troublemaker characters.
991 // Should these be merged into the title char list?
992 $unicodeBlacklist = '/[' .
993 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
994 '\x{00a0}' . # non-breaking space
995 '\x{2000}-\x{200f}' . # various whitespace
996 '\x{2028}-\x{202f}' . # breaks and control chars
997 '\x{3000}' . # ideographic space
998 '\x{e000}-\x{f8ff}' . # private use
1000 if ( preg_match( $unicodeBlacklist, $name ) ) {
1008 * Usernames which fail to pass this function will be blocked
1009 * from user login and new account registrations, but may be used
1010 * internally by batch processes.
1012 * If an account already exists in this form, login will be blocked
1013 * by a failure to pass this function.
1015 * @param string $name Name to match
1018 public static function isUsableName( $name ) {
1019 global $wgReservedUsernames;
1020 // Must be a valid username, obviously ;)
1021 if ( !self
::isValidUserName( $name ) ) {
1025 static $reservedUsernames = false;
1026 if ( !$reservedUsernames ) {
1027 $reservedUsernames = $wgReservedUsernames;
1028 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
1031 // Certain names may be reserved for batch processes.
1032 foreach ( $reservedUsernames as $reserved ) {
1033 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
1034 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
1036 if ( $reserved == $name ) {
1044 * Return the users who are members of the given group(s). In case of multiple groups,
1045 * users who are members of at least one of them are returned.
1047 * @param string|array $groups A single group name or an array of group names
1048 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
1049 * records; larger values are ignored.
1050 * @param int $after ID the user to start after
1051 * @return UserArrayFromResult
1053 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
1054 if ( $groups === [] ) {
1055 return UserArrayFromResult
::newFromIDs( [] );
1058 $groups = array_unique( (array)$groups );
1059 $limit = min( 5000, $limit );
1061 $conds = [ 'ug_group' => $groups ];
1062 if ( $after !== null ) {
1063 $conds[] = 'ug_user > ' . (int)$after;
1066 $dbr = wfGetDB( DB_REPLICA
);
1067 $ids = $dbr->selectFieldValues(
1074 'ORDER BY' => 'ug_user',
1078 return UserArray
::newFromIDs( $ids );
1082 * Usernames which fail to pass this function will be blocked
1083 * from new account registrations, but may be used internally
1084 * either by batch processes or by user accounts which have
1085 * already been created.
1087 * Additional blacklisting may be added here rather than in
1088 * isValidUserName() to avoid disrupting existing accounts.
1090 * @param string $name String to match
1093 public static function isCreatableName( $name ) {
1094 global $wgInvalidUsernameCharacters;
1096 // Ensure that the username isn't longer than 235 bytes, so that
1097 // (at least for the builtin skins) user javascript and css files
1098 // will work. (T25080)
1099 if ( strlen( $name ) > 235 ) {
1100 wfDebugLog( 'username', __METHOD__
.
1101 ": '$name' invalid due to length" );
1105 // Preg yells if you try to give it an empty string
1106 if ( $wgInvalidUsernameCharacters !== '' ) {
1107 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
1108 wfDebugLog( 'username', __METHOD__
.
1109 ": '$name' invalid due to wgInvalidUsernameCharacters" );
1114 return self
::isUsableName( $name );
1118 * Is the input a valid password for this user?
1120 * @param string $password Desired password
1123 public function isValidPassword( $password ) {
1124 // simple boolean wrapper for getPasswordValidity
1125 return $this->getPasswordValidity( $password ) === true;
1129 * Given unvalidated password input, return error message on failure.
1131 * @param string $password Desired password
1132 * @return bool|string|array True on success, string or array of error message on failure
1134 public function getPasswordValidity( $password ) {
1135 $result = $this->checkPasswordValidity( $password );
1136 if ( $result->isGood() ) {
1140 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
1141 $messages[] = $error['message'];
1143 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
1144 $messages[] = $warning['message'];
1146 if ( count( $messages ) === 1 ) {
1147 return $messages[0];
1154 * Check if this is a valid password for this user
1156 * Create a Status object based on the password's validity.
1157 * The Status should be set to fatal if the user should not
1158 * be allowed to log in, and should have any errors that
1159 * would block changing the password.
1161 * If the return value of this is not OK, the password
1162 * should not be checked. If the return value is not Good,
1163 * the password can be checked, but the user should not be
1164 * able to set their password to this.
1166 * @param string $password Desired password
1170 public function checkPasswordValidity( $password ) {
1171 global $wgPasswordPolicy;
1173 $upp = new UserPasswordPolicy(
1174 $wgPasswordPolicy['policies'],
1175 $wgPasswordPolicy['checks']
1178 $status = Status
::newGood();
1179 $result = false; // init $result to false for the internal checks
1181 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1182 $status->error( $result );
1186 if ( $result === false ) {
1187 $status->merge( $upp->checkUserPassword( $this, $password ) );
1189 } elseif ( $result === true ) {
1192 $status->error( $result );
1193 return $status; // the isValidPassword hook set a string $result and returned true
1198 * Given unvalidated user input, return a canonical username, or false if
1199 * the username is invalid.
1200 * @param string $name User input
1201 * @param string|bool $validate Type of validation to use:
1202 * - false No validation
1203 * - 'valid' Valid for batch processes
1204 * - 'usable' Valid for batch processes and login
1205 * - 'creatable' Valid for batch processes, login and account creation
1207 * @throws InvalidArgumentException
1208 * @return bool|string
1210 public static function getCanonicalName( $name, $validate = 'valid' ) {
1211 // Force usernames to capital
1213 $name = $wgContLang->ucfirst( $name );
1215 # Reject names containing '#'; these will be cleaned up
1216 # with title normalisation, but then it's too late to
1218 if ( strpos( $name, '#' ) !== false ) {
1222 // Clean up name according to title rules,
1223 // but only when validation is requested (T14654)
1224 $t = ( $validate !== false ) ?
1225 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1226 // Check for invalid titles
1227 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1231 // Reject various classes of invalid names
1232 $name = AuthManager
::callLegacyAuthPlugin(
1233 'getCanonicalName', [ $t->getText() ], $t->getText()
1236 switch ( $validate ) {
1240 if ( !self
::isValidUserName( $name ) ) {
1245 if ( !self
::isUsableName( $name ) ) {
1250 if ( !self
::isCreatableName( $name ) ) {
1255 throw new InvalidArgumentException(
1256 'Invalid parameter value for $validate in ' . __METHOD__
);
1262 * Return a random password.
1264 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1265 * @return string New random password
1267 public static function randomPassword() {
1268 global $wgMinimalPasswordLength;
1269 return PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1273 * Set cached properties to default.
1275 * @note This no longer clears uncached lazy-initialised properties;
1276 * the constructor does that instead.
1278 * @param string|bool $name
1280 public function loadDefaults( $name = false ) {
1282 $this->mName
= $name;
1283 $this->mActorId
= null;
1284 $this->mRealName
= '';
1286 $this->mOptionOverrides
= null;
1287 $this->mOptionsLoaded
= false;
1289 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1290 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1291 if ( $loggedOut !== 0 ) {
1292 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1294 $this->mTouched
= '1'; # Allow any pages to be cached
1297 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1298 $this->mEmailAuthenticated
= null;
1299 $this->mEmailToken
= '';
1300 $this->mEmailTokenExpires
= null;
1301 $this->mRegistration
= wfTimestamp( TS_MW
);
1302 $this->mGroupMemberships
= [];
1304 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1308 * Return whether an item has been loaded.
1310 * @param string $item Item to check. Current possibilities:
1314 * @param string $all 'all' to check if the whole object has been loaded
1315 * or any other string to check if only the item is available (e.g.
1319 public function isItemLoaded( $item, $all = 'all' ) {
1320 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1321 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1325 * Set that an item has been loaded
1327 * @param string $item
1329 protected function setItemLoaded( $item ) {
1330 if ( is_array( $this->mLoadedItems
) ) {
1331 $this->mLoadedItems
[$item] = true;
1336 * Load user data from the session.
1338 * @return bool True if the user is logged in, false otherwise.
1340 private function loadFromSession() {
1343 Hooks
::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1344 if ( $result !== null ) {
1348 // MediaWiki\Session\Session already did the necessary authentication of the user
1349 // returned here, so just use it if applicable.
1350 $session = $this->getRequest()->getSession();
1351 $user = $session->getUser();
1352 if ( $user->isLoggedIn() ) {
1353 $this->loadFromUserObject( $user );
1355 // If this user is autoblocked, set a cookie to track the Block. This has to be done on
1356 // every session load, because an autoblocked editor might not edit again from the same
1357 // IP address after being blocked.
1358 $config = RequestContext
::getMain()->getConfig();
1359 if ( $config->get( 'CookieSetOnAutoblock' ) === true ) {
1360 $block = $this->getBlock();
1361 $shouldSetCookie = $this->getRequest()->getCookie( 'BlockID' ) === null
1363 && $block->getType() === Block
::TYPE_USER
1364 && $block->isAutoblocking();
1365 if ( $shouldSetCookie ) {
1366 wfDebug( __METHOD__
. ': User is autoblocked, setting cookie to track' );
1367 $block->setCookie( $this->getRequest()->response() );
1371 // Other code expects these to be set in the session, so set them.
1372 $session->set( 'wsUserID', $this->getId() );
1373 $session->set( 'wsUserName', $this->getName() );
1374 $session->set( 'wsToken', $this->getToken() );
1381 * Load user and user_group data from the database.
1382 * $this->mId must be set, this is how the user is identified.
1384 * @param int $flags User::READ_* constant bitfield
1385 * @return bool True if the user exists, false if the user is anonymous
1387 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1389 $this->mId
= intval( $this->mId
);
1391 if ( !$this->mId
) {
1392 // Anonymous users are not in the database
1393 $this->loadDefaults();
1397 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1398 $db = wfGetDB( $index );
1400 $userQuery = self
::getQueryInfo();
1401 $s = $db->selectRow(
1402 $userQuery['tables'],
1403 $userQuery['fields'],
1404 [ 'user_id' => $this->mId
],
1410 $this->queryFlagsUsed
= $flags;
1411 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1413 if ( $s !== false ) {
1414 // Initialise user table data
1415 $this->loadFromRow( $s );
1416 $this->mGroupMemberships
= null; // deferred
1417 $this->getEditCount(); // revalidation for nulls
1422 $this->loadDefaults();
1428 * Initialize this object from a row from the user table.
1430 * @param stdClass $row Row from the user table to load.
1431 * @param array $data Further user data to load into the object
1433 * user_groups Array of arrays or stdClass result rows out of the user_groups
1434 * table. Previously you were supposed to pass an array of strings
1435 * here, but we also need expiry info nowadays, so an array of
1436 * strings is ignored.
1437 * user_properties Array with properties out of the user_properties table
1439 protected function loadFromRow( $row, $data = null ) {
1440 global $wgActorTableSchemaMigrationStage;
1442 if ( !is_object( $row ) ) {
1443 throw new InvalidArgumentException( '$row must be an object' );
1448 $this->mGroupMemberships
= null; // deferred
1450 if ( $wgActorTableSchemaMigrationStage > MIGRATION_OLD
) {
1451 if ( isset( $row->actor_id
) ) {
1452 $this->mActorId
= (int)$row->actor_id
;
1453 if ( $this->mActorId
!== 0 ) {
1454 $this->mFrom
= 'actor';
1456 $this->setItemLoaded( 'actor' );
1462 if ( isset( $row->user_name
) && $row->user_name
!== '' ) {
1463 $this->mName
= $row->user_name
;
1464 $this->mFrom
= 'name';
1465 $this->setItemLoaded( 'name' );
1470 if ( isset( $row->user_real_name
) ) {
1471 $this->mRealName
= $row->user_real_name
;
1472 $this->setItemLoaded( 'realname' );
1477 if ( isset( $row->user_id
) ) {
1478 $this->mId
= intval( $row->user_id
);
1479 if ( $this->mId
!== 0 ) {
1480 $this->mFrom
= 'id';
1482 $this->setItemLoaded( 'id' );
1487 if ( isset( $row->user_id
) && isset( $row->user_name
) && $row->user_name
!== '' ) {
1488 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1491 if ( isset( $row->user_editcount
) ) {
1492 $this->mEditCount
= $row->user_editcount
;
1497 if ( isset( $row->user_touched
) ) {
1498 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1503 if ( isset( $row->user_token
) ) {
1504 // The definition for the column is binary(32), so trim the NULs
1505 // that appends. The previous definition was char(32), so trim
1507 $this->mToken
= rtrim( $row->user_token
, " \0" );
1508 if ( $this->mToken
=== '' ) {
1509 $this->mToken
= null;
1515 if ( isset( $row->user_email
) ) {
1516 $this->mEmail
= $row->user_email
;
1517 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1518 $this->mEmailToken
= $row->user_email_token
;
1519 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1520 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1526 $this->mLoadedItems
= true;
1529 if ( is_array( $data ) ) {
1530 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1531 if ( !count( $data['user_groups'] ) ) {
1532 $this->mGroupMemberships
= [];
1534 $firstGroup = reset( $data['user_groups'] );
1535 if ( is_array( $firstGroup ) ||
is_object( $firstGroup ) ) {
1536 $this->mGroupMemberships
= [];
1537 foreach ( $data['user_groups'] as $row ) {
1538 $ugm = UserGroupMembership
::newFromRow( (object)$row );
1539 $this->mGroupMemberships
[$ugm->getGroup()] = $ugm;
1544 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1545 $this->loadOptions( $data['user_properties'] );
1551 * Load the data for this user object from another user object.
1555 protected function loadFromUserObject( $user ) {
1557 foreach ( self
::$mCacheVars as $var ) {
1558 $this->$var = $user->$var;
1563 * Load the groups from the database if they aren't already loaded.
1565 private function loadGroups() {
1566 if ( is_null( $this->mGroupMemberships
) ) {
1567 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1568 ?
wfGetDB( DB_MASTER
)
1569 : wfGetDB( DB_REPLICA
);
1570 $this->mGroupMemberships
= UserGroupMembership
::getMembershipsForUser(
1576 * Add the user to the group if he/she meets given criteria.
1578 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1579 * possible to remove manually via Special:UserRights. In such case it
1580 * will not be re-added automatically. The user will also not lose the
1581 * group if they no longer meet the criteria.
1583 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1585 * @return array Array of groups the user has been promoted to.
1587 * @see $wgAutopromoteOnce
1589 public function addAutopromoteOnceGroups( $event ) {
1590 global $wgAutopromoteOnceLogInRC;
1592 if ( wfReadOnly() ||
!$this->getId() ) {
1596 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1597 if ( !count( $toPromote ) ) {
1601 if ( !$this->checkAndSetTouched() ) {
1602 return []; // raced out (bug T48834)
1605 $oldGroups = $this->getGroups(); // previous groups
1606 $oldUGMs = $this->getGroupMemberships();
1607 foreach ( $toPromote as $group ) {
1608 $this->addGroup( $group );
1610 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1611 $newUGMs = $this->getGroupMemberships();
1613 // update groups in external authentication database
1614 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );
1615 AuthManager
::callLegacyAuthPlugin( 'updateExternalDBGroups', [ $this, $toPromote ] );
1617 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1618 $logEntry->setPerformer( $this );
1619 $logEntry->setTarget( $this->getUserPage() );
1620 $logEntry->setParameters( [
1621 '4::oldgroups' => $oldGroups,
1622 '5::newgroups' => $newGroups,
1624 $logid = $logEntry->insert();
1625 if ( $wgAutopromoteOnceLogInRC ) {
1626 $logEntry->publish( $logid );
1633 * Builds update conditions. Additional conditions may be added to $conditions to
1634 * protected against race conditions using a compare-and-set (CAS) mechanism
1635 * based on comparing $this->mTouched with the user_touched field.
1637 * @param Database $db
1638 * @param array $conditions WHERE conditions for use with Database::update
1639 * @return array WHERE conditions for use with Database::update
1641 protected function makeUpdateConditions( Database
$db, array $conditions ) {
1642 if ( $this->mTouched
) {
1643 // CAS check: only update if the row wasn't changed sicne it was loaded.
1644 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1651 * Bump user_touched if it didn't change since this object was loaded
1653 * On success, the mTouched field is updated.
1654 * The user serialization cache is always cleared.
1656 * @return bool Whether user_touched was actually updated
1659 protected function checkAndSetTouched() {
1662 if ( !$this->mId
) {
1663 return false; // anon
1666 // Get a new user_touched that is higher than the old one
1667 $newTouched = $this->newTouchedTimestamp();
1669 $dbw = wfGetDB( DB_MASTER
);
1670 $dbw->update( 'user',
1671 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1672 $this->makeUpdateConditions( $dbw, [
1673 'user_id' => $this->mId
,
1677 $success = ( $dbw->affectedRows() > 0 );
1680 $this->mTouched
= $newTouched;
1681 $this->clearSharedCache();
1683 // Clears on failure too since that is desired if the cache is stale
1684 $this->clearSharedCache( 'refresh' );
1691 * Clear various cached data stored in this object. The cache of the user table
1692 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1694 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1695 * given source. May be "name", "id", "actor", "defaults", "session", or false for no reload.
1697 public function clearInstanceCache( $reloadFrom = false ) {
1698 $this->mNewtalk
= -1;
1699 $this->mDatePreference
= null;
1700 $this->mBlockedby
= -1; # Unset
1701 $this->mHash
= false;
1702 $this->mRights
= null;
1703 $this->mEffectiveGroups
= null;
1704 $this->mImplicitGroups
= null;
1705 $this->mGroupMemberships
= null;
1706 $this->mOptions
= null;
1707 $this->mOptionsLoaded
= false;
1708 $this->mEditCount
= null;
1710 if ( $reloadFrom ) {
1711 $this->mLoadedItems
= [];
1712 $this->mFrom
= $reloadFrom;
1717 * Combine the language default options with any site-specific options
1718 * and add the default language variants.
1720 * @return array Array of String options
1722 public static function getDefaultOptions() {
1723 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1725 static $defOpt = null;
1726 static $defOptLang = null;
1728 if ( $defOpt !== null && $defOptLang === $wgContLang->getCode() ) {
1729 // $wgContLang does not change (and should not change) mid-request,
1730 // but the unit tests change it anyway, and expect this method to
1731 // return values relevant to the current $wgContLang.
1735 $defOpt = $wgDefaultUserOptions;
1736 // Default language setting
1737 $defOptLang = $wgContLang->getCode();
1738 $defOpt['language'] = $defOptLang;
1739 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1740 $defOpt[$langCode == $wgContLang->getCode() ?
'variant' : "variant-$langCode"] = $langCode;
1743 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1744 // since extensions may change the set of searchable namespaces depending
1745 // on user groups/permissions.
1746 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1747 $defOpt['searchNs' . $nsnum] = (bool)$val;
1749 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1751 Hooks
::run( 'UserGetDefaultOptions', [ &$defOpt ] );
1757 * Get a given default option value.
1759 * @param string $opt Name of option to retrieve
1760 * @return string Default option value
1762 public static function getDefaultOption( $opt ) {
1763 $defOpts = self
::getDefaultOptions();
1764 if ( isset( $defOpts[$opt] ) ) {
1765 return $defOpts[$opt];
1772 * Get blocking information
1773 * @param bool $bFromSlave Whether to check the replica DB first.
1774 * To improve performance, non-critical checks are done against replica DBs.
1775 * Check when actually saving should be done against master.
1777 private function getBlockedStatus( $bFromSlave = true ) {
1778 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff, $wgSoftBlockRanges;
1780 if ( -1 != $this->mBlockedby
) {
1784 wfDebug( __METHOD__
. ": checking...\n" );
1786 // Initialize data...
1787 // Otherwise something ends up stomping on $this->mBlockedby when
1788 // things get lazy-loaded later, causing false positive block hits
1789 // due to -1 !== 0. Probably session-related... Nothing should be
1790 // overwriting mBlockedby, surely?
1793 # We only need to worry about passing the IP address to the Block generator if the
1794 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1795 # know which IP address they're actually coming from
1797 if ( !$this->isAllowed( 'ipblock-exempt' ) ) {
1798 // $wgUser->getName() only works after the end of Setup.php. Until
1799 // then, assume it's a logged-out user.
1800 $globalUserName = $wgUser->isSafeToLoad()
1801 ?
$wgUser->getName()
1802 : IP
::sanitizeIP( $wgUser->getRequest()->getIP() );
1803 if ( $this->getName() === $globalUserName ) {
1804 $ip = $this->getRequest()->getIP();
1809 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1812 if ( !$block instanceof Block
) {
1813 $block = $this->getBlockFromCookieValue( $this->getRequest()->getCookie( 'BlockID' ) );
1817 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1819 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1820 $block = new Block( [
1821 'byText' => wfMessage( 'proxyblocker' )->text(),
1822 'reason' => wfMessage( 'proxyblockreason' )->text(),
1824 'systemBlock' => 'proxy',
1826 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1827 $block = new Block( [
1828 'byText' => wfMessage( 'sorbs' )->text(),
1829 'reason' => wfMessage( 'sorbsreason' )->text(),
1831 'systemBlock' => 'dnsbl',
1836 // (T25343) Apply IP blocks to the contents of XFF headers, if enabled
1837 if ( !$block instanceof Block
1838 && $wgApplyIpBlocksToXff
1840 && !in_array( $ip, $wgProxyWhitelist )
1842 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1843 $xff = array_map( 'trim', explode( ',', $xff ) );
1844 $xff = array_diff( $xff, [ $ip ] );
1845 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1846 $block = Block
::chooseBlock( $xffblocks, $xff );
1847 if ( $block instanceof Block
) {
1848 # Mangle the reason to alert the user that the block
1849 # originated from matching the X-Forwarded-For header.
1850 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->text();
1854 if ( !$block instanceof Block
1857 && IP
::isInRanges( $ip, $wgSoftBlockRanges )
1859 $block = new Block( [
1861 'byText' => 'MediaWiki default',
1862 'reason' => wfMessage( 'softblockrangesreason', $ip )->text(),
1864 'systemBlock' => 'wgSoftBlockRanges',
1868 if ( $block instanceof Block
) {
1869 wfDebug( __METHOD__
. ": Found block.\n" );
1870 $this->mBlock
= $block;
1871 $this->mBlockedby
= $block->getByName();
1872 $this->mBlockreason
= $block->mReason
;
1873 $this->mHideName
= $block->mHideName
;
1874 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1876 $this->mBlock
= null;
1877 $this->mBlockedby
= '';
1878 $this->mBlockreason
= '';
1879 $this->mHideName
= 0;
1880 $this->mAllowUsertalk
= false;
1883 // Avoid PHP 7.1 warning of passing $this by reference
1886 Hooks
::run( 'GetBlockedStatus', [ &$user ] );
1890 * Try to load a Block from an ID given in a cookie value.
1891 * @param string|null $blockCookieVal The cookie value to check.
1892 * @return Block|bool The Block object, or false if none could be loaded.
1894 protected function getBlockFromCookieValue( $blockCookieVal ) {
1895 // Make sure there's something to check. The cookie value must start with a number.
1896 if ( strlen( $blockCookieVal ) < 1 ||
!is_numeric( substr( $blockCookieVal, 0, 1 ) ) ) {
1899 // Load the Block from the ID in the cookie.
1900 $blockCookieId = Block
::getIdFromCookieValue( $blockCookieVal );
1901 if ( $blockCookieId !== null ) {
1902 // An ID was found in the cookie.
1903 $tmpBlock = Block
::newFromID( $blockCookieId );
1904 if ( $tmpBlock instanceof Block
) {
1905 // Check the validity of the block.
1906 $blockIsValid = $tmpBlock->getType() == Block
::TYPE_USER
1907 && !$tmpBlock->isExpired()
1908 && $tmpBlock->isAutoblocking();
1909 $config = RequestContext
::getMain()->getConfig();
1910 $useBlockCookie = ( $config->get( 'CookieSetOnAutoblock' ) === true );
1911 if ( $blockIsValid && $useBlockCookie ) {
1915 // If the block is not valid, remove the cookie.
1916 Block
::clearCookie( $this->getRequest()->response() );
1919 // If the block doesn't exist, remove the cookie.
1920 Block
::clearCookie( $this->getRequest()->response() );
1927 * Whether the given IP is in a DNS blacklist.
1929 * @param string $ip IP to check
1930 * @param bool $checkWhitelist Whether to check the whitelist first
1931 * @return bool True if blacklisted.
1933 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1934 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1936 if ( !$wgEnableDnsBlacklist ) {
1940 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1944 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
1948 * Whether the given IP is in a given DNS blacklist.
1950 * @param string $ip IP to check
1951 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1952 * @return bool True if blacklisted.
1954 public function inDnsBlacklist( $ip, $bases ) {
1956 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
1957 if ( IP
::isIPv4( $ip ) ) {
1958 // Reverse IP, T23255
1959 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1961 foreach ( (array)$bases as $base ) {
1963 // If we have an access key, use that too (ProjectHoneypot, etc.)
1965 if ( is_array( $base ) ) {
1966 if ( count( $base ) >= 2 ) {
1967 // Access key is 1, base URL is 0
1968 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1970 $host = "$ipReversed.{$base[0]}";
1972 $basename = $base[0];
1974 $host = "$ipReversed.$base";
1978 $ipList = gethostbynamel( $host );
1981 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
1985 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
1994 * Check if an IP address is in the local proxy list
2000 public static function isLocallyBlockedProxy( $ip ) {
2001 global $wgProxyList;
2003 if ( !$wgProxyList ) {
2007 if ( !is_array( $wgProxyList ) ) {
2008 // Load values from the specified file
2009 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
2012 $resultProxyList = [];
2013 $deprecatedIPEntries = [];
2015 // backward compatibility: move all ip addresses in keys to values
2016 foreach ( $wgProxyList as $key => $value ) {
2017 $keyIsIP = IP
::isIPAddress( $key );
2018 $valueIsIP = IP
::isIPAddress( $value );
2019 if ( $keyIsIP && !$valueIsIP ) {
2020 $deprecatedIPEntries[] = $key;
2021 $resultProxyList[] = $key;
2022 } elseif ( $keyIsIP && $valueIsIP ) {
2023 $deprecatedIPEntries[] = $key;
2024 $resultProxyList[] = $key;
2025 $resultProxyList[] = $value;
2027 $resultProxyList[] = $value;
2031 if ( $deprecatedIPEntries ) {
2033 'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
2034 implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
2037 $proxyListIPSet = new IPSet( $resultProxyList );
2038 return $proxyListIPSet->match( $ip );
2042 * Is this user subject to rate limiting?
2044 * @return bool True if rate limited
2046 public function isPingLimitable() {
2047 global $wgRateLimitsExcludedIPs;
2048 if ( IP
::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
2049 // No other good way currently to disable rate limits
2050 // for specific IPs. :P
2051 // But this is a crappy hack and should die.
2054 return !$this->isAllowed( 'noratelimit' );
2058 * Primitive rate limits: enforce maximum actions per time period
2059 * to put a brake on flooding.
2061 * The method generates both a generic profiling point and a per action one
2062 * (suffix being "-$action".
2064 * @note When using a shared cache like memcached, IP-address
2065 * last-hit counters will be shared across wikis.
2067 * @param string $action Action to enforce; 'edit' if unspecified
2068 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
2069 * @return bool True if a rate limiter was tripped
2071 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
2072 // Avoid PHP 7.1 warning of passing $this by reference
2074 // Call the 'PingLimiter' hook
2076 if ( !Hooks
::run( 'PingLimiter', [ &$user, $action, &$result, $incrBy ] ) ) {
2080 global $wgRateLimits;
2081 if ( !isset( $wgRateLimits[$action] ) ) {
2085 $limits = array_merge(
2086 [ '&can-bypass' => true ],
2087 $wgRateLimits[$action]
2090 // Some groups shouldn't trigger the ping limiter, ever
2091 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
2096 $id = $this->getId();
2098 $isNewbie = $this->isNewbie();
2099 $cache = ObjectCache
::getLocalClusterInstance();
2103 if ( isset( $limits['anon'] ) ) {
2104 $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
2107 // limits for logged-in users
2108 if ( isset( $limits['user'] ) ) {
2109 $userLimit = $limits['user'];
2113 // limits for anons and for newbie logged-in users
2116 if ( isset( $limits['ip'] ) ) {
2117 $ip = $this->getRequest()->getIP();
2118 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
2120 // subnet-based limits
2121 if ( isset( $limits['subnet'] ) ) {
2122 $ip = $this->getRequest()->getIP();
2123 $subnet = IP
::getSubnet( $ip );
2124 if ( $subnet !== false ) {
2125 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
2130 // Check for group-specific permissions
2131 // If more than one group applies, use the group with the highest limit ratio (max/period)
2132 foreach ( $this->getGroups() as $group ) {
2133 if ( isset( $limits[$group] ) ) {
2134 if ( $userLimit === false
2135 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
2137 $userLimit = $limits[$group];
2142 // limits for newbie logged-in users (override all the normal user limits)
2143 if ( $id !== 0 && $isNewbie && isset( $limits['newbie'] ) ) {
2144 $userLimit = $limits['newbie'];
2147 // Set the user limit key
2148 if ( $userLimit !== false ) {
2149 list( $max, $period ) = $userLimit;
2150 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
2151 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
2154 // ip-based limits for all ping-limitable users
2155 if ( isset( $limits['ip-all'] ) ) {
2156 $ip = $this->getRequest()->getIP();
2157 // ignore if user limit is more permissive
2158 if ( $isNewbie ||
$userLimit === false
2159 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
2160 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
2164 // subnet-based limits for all ping-limitable users
2165 if ( isset( $limits['subnet-all'] ) ) {
2166 $ip = $this->getRequest()->getIP();
2167 $subnet = IP
::getSubnet( $ip );
2168 if ( $subnet !== false ) {
2169 // ignore if user limit is more permissive
2170 if ( $isNewbie ||
$userLimit === false
2171 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
2172 > $userLimit[0] / $userLimit[1] ) {
2173 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
2179 foreach ( $keys as $key => $limit ) {
2180 list( $max, $period ) = $limit;
2181 $summary = "(limit $max in {$period}s)";
2182 $count = $cache->get( $key );
2185 if ( $count >= $max ) {
2186 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
2187 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
2190 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
2193 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
2194 if ( $incrBy > 0 ) {
2195 $cache->add( $key, 0, intval( $period ) ); // first ping
2198 if ( $incrBy > 0 ) {
2199 $cache->incr( $key, $incrBy );
2207 * Check if user is blocked
2209 * @param bool $bFromSlave Whether to check the replica DB instead of
2210 * the master. Hacked from false due to horrible probs on site.
2211 * @return bool True if blocked, false otherwise
2213 public function isBlocked( $bFromSlave = true ) {
2214 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
2218 * Get the block affecting the user, or null if the user is not blocked
2220 * @param bool $bFromSlave Whether to check the replica DB instead of the master
2221 * @return Block|null
2223 public function getBlock( $bFromSlave = true ) {
2224 $this->getBlockedStatus( $bFromSlave );
2225 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
2229 * Check if user is blocked from editing a particular article
2231 * @param Title $title Title to check
2232 * @param bool $bFromSlave Whether to check the replica DB instead of the master
2235 public function isBlockedFrom( $title, $bFromSlave = false ) {
2236 global $wgBlockAllowsUTEdit;
2238 $blocked = $this->isBlocked( $bFromSlave );
2239 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
2240 // If a user's name is suppressed, they cannot make edits anywhere
2241 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName()
2242 && $title->getNamespace() == NS_USER_TALK
) {
2244 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
2247 Hooks
::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
2253 * If user is blocked, return the name of the user who placed the block
2254 * @return string Name of blocker
2256 public function blockedBy() {
2257 $this->getBlockedStatus();
2258 return $this->mBlockedby
;
2262 * If user is blocked, return the specified reason for the block
2263 * @return string Blocking reason
2265 public function blockedFor() {
2266 $this->getBlockedStatus();
2267 return $this->mBlockreason
;
2271 * If user is blocked, return the ID for the block
2272 * @return int Block ID
2274 public function getBlockId() {
2275 $this->getBlockedStatus();
2276 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2280 * Check if user is blocked on all wikis.
2281 * Do not use for actual edit permission checks!
2282 * This is intended for quick UI checks.
2284 * @param string $ip IP address, uses current client if none given
2285 * @return bool True if blocked, false otherwise
2287 public function isBlockedGlobally( $ip = '' ) {
2288 return $this->getGlobalBlock( $ip ) instanceof Block
;
2292 * Check if user is blocked on all wikis.
2293 * Do not use for actual edit permission checks!
2294 * This is intended for quick UI checks.
2296 * @param string $ip IP address, uses current client if none given
2297 * @return Block|null Block object if blocked, null otherwise
2298 * @throws FatalError
2299 * @throws MWException
2301 public function getGlobalBlock( $ip = '' ) {
2302 if ( $this->mGlobalBlock
!== null ) {
2303 return $this->mGlobalBlock ?
: null;
2305 // User is already an IP?
2306 if ( IP
::isIPAddress( $this->getName() ) ) {
2307 $ip = $this->getName();
2309 $ip = $this->getRequest()->getIP();
2311 // Avoid PHP 7.1 warning of passing $this by reference
2315 Hooks
::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
2317 if ( $blocked && $block === null ) {
2318 // back-compat: UserIsBlockedGlobally didn't have $block param first
2319 $block = new Block( [
2321 'systemBlock' => 'global-block'
2325 $this->mGlobalBlock
= $blocked ?
$block : false;
2326 return $this->mGlobalBlock ?
: null;
2330 * Check if user account is locked
2332 * @return bool True if locked, false otherwise
2334 public function isLocked() {
2335 if ( $this->mLocked
!== null ) {
2336 return $this->mLocked
;
2338 // Avoid PHP 7.1 warning of passing $this by reference
2340 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$user ], null );
2341 $this->mLocked
= $authUser && $authUser->isLocked();
2342 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2343 return $this->mLocked
;
2347 * Check if user account is hidden
2349 * @return bool True if hidden, false otherwise
2351 public function isHidden() {
2352 if ( $this->mHideName
!== null ) {
2353 return $this->mHideName
;
2355 $this->getBlockedStatus();
2356 if ( !$this->mHideName
) {
2357 // Avoid PHP 7.1 warning of passing $this by reference
2359 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$user ], null );
2360 $this->mHideName
= $authUser && $authUser->isHidden();
2361 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2363 return $this->mHideName
;
2367 * Get the user's ID.
2368 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2370 public function getId() {
2371 if ( $this->mId
=== null && $this->mName
!== null && self
::isIP( $this->mName
) ) {
2372 // Special case, we know the user is anonymous
2374 } elseif ( !$this->isItemLoaded( 'id' ) ) {
2375 // Don't load if this was initialized from an ID
2379 return (int)$this->mId
;
2383 * Set the user and reload all fields according to a given ID
2384 * @param int $v User ID to reload
2386 public function setId( $v ) {
2388 $this->clearInstanceCache( 'id' );
2392 * Get the user name, or the IP of an anonymous user
2393 * @return string User's name or IP address
2395 public function getName() {
2396 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2397 // Special case optimisation
2398 return $this->mName
;
2401 if ( $this->mName
=== false ) {
2403 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2405 return $this->mName
;
2410 * Set the user name.
2412 * This does not reload fields from the database according to the given
2413 * name. Rather, it is used to create a temporary "nonexistent user" for
2414 * later addition to the database. It can also be used to set the IP
2415 * address for an anonymous user to something other than the current
2418 * @note User::newFromName() has roughly the same function, when the named user
2420 * @param string $str New user name to set
2422 public function setName( $str ) {
2424 $this->mName
= $str;
2428 * Get the user's actor ID.
2430 * @param IDatabase|null $dbw Assign a new actor ID, using this DB handle, if none exists
2431 * @return int The actor's ID, or 0 if no actor ID exists and $dbw was null
2433 public function getActorId( IDatabase
$dbw = null ) {
2434 global $wgActorTableSchemaMigrationStage;
2436 if ( $wgActorTableSchemaMigrationStage <= MIGRATION_OLD
) {
2440 if ( !$this->isItemLoaded( 'actor' ) ) {
2444 // Currently $this->mActorId might be null if $this was loaded from a
2445 // cache entry that was written when $wgActorTableSchemaMigrationStage
2446 // was MIGRATION_OLD. Once that is no longer a possibility (i.e. when
2447 // User::VERSION is incremented after $wgActorTableSchemaMigrationStage
2448 // has been removed), that condition may be removed.
2449 if ( $this->mActorId
=== null ||
!$this->mActorId
&& $dbw ) {
2451 'actor_user' => $this->getId() ?
: null,
2452 'actor_name' => (string)$this->getName(),
2455 if ( $q['actor_user'] === null && self
::isUsableName( $q['actor_name'] ) ) {
2456 throw new CannotCreateActorException(
2457 'Cannot create an actor for a usable name that is not an existing user'
2460 if ( $q['actor_name'] === '' ) {
2461 throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
2463 $dbw->insert( 'actor', $q, __METHOD__
, [ 'IGNORE' ] );
2464 if ( $dbw->affectedRows() ) {
2465 $this->mActorId
= (int)$dbw->insertId();
2468 // Use LOCK IN SHARE MODE to bypass any MySQL REPEATABLE-READ snapshot.
2469 $this->mActorId
= (int)$dbw->selectField(
2474 [ 'LOCK IN SHARE MODE' ]
2476 if ( !$this->mActorId
) {
2477 throw new CannotCreateActorException(
2478 "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
2482 $this->invalidateCache();
2484 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2485 $db = wfGetDB( $index );
2486 $this->mActorId
= (int)$db->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2488 $this->setItemLoaded( 'actor' );
2491 return (int)$this->mActorId
;
2495 * Get the user's name escaped by underscores.
2496 * @return string Username escaped by underscores.
2498 public function getTitleKey() {
2499 return str_replace( ' ', '_', $this->getName() );
2503 * Check if the user has new messages.
2504 * @return bool True if the user has new messages
2506 public function getNewtalk() {
2509 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2510 if ( $this->mNewtalk
=== -1 ) {
2511 $this->mNewtalk
= false; # reset talk page status
2513 // Check memcached separately for anons, who have no
2514 // entire User object stored in there.
2515 if ( !$this->mId
) {
2516 global $wgDisableAnonTalk;
2517 if ( $wgDisableAnonTalk ) {
2518 // Anon newtalk disabled by configuration.
2519 $this->mNewtalk
= false;
2521 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2524 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2528 return (bool)$this->mNewtalk
;
2532 * Return the data needed to construct links for new talk page message
2533 * alerts. If there are new messages, this will return an associative array
2534 * with the following data:
2535 * wiki: The database name of the wiki
2536 * link: Root-relative link to the user's talk page
2537 * rev: The last talk page revision that the user has seen or null. This
2538 * is useful for building diff links.
2539 * If there are no new messages, it returns an empty array.
2540 * @note This function was designed to accomodate multiple talk pages, but
2541 * currently only returns a single link and revision.
2544 public function getNewMessageLinks() {
2545 // Avoid PHP 7.1 warning of passing $this by reference
2548 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
2550 } elseif ( !$this->getNewtalk() ) {
2553 $utp = $this->getTalkPage();
2554 $dbr = wfGetDB( DB_REPLICA
);
2555 // Get the "last viewed rev" timestamp from the oldest message notification
2556 $timestamp = $dbr->selectField( 'user_newtalk',
2557 'MIN(user_last_timestamp)',
2558 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2560 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2561 return [ [ 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ] ];
2565 * Get the revision ID for the last talk page revision viewed by the talk
2567 * @return int|null Revision ID or null
2569 public function getNewMessageRevisionId() {
2570 $newMessageRevisionId = null;
2571 $newMessageLinks = $this->getNewMessageLinks();
2572 if ( $newMessageLinks ) {
2573 // Note: getNewMessageLinks() never returns more than a single link
2574 // and it is always for the same wiki, but we double-check here in
2575 // case that changes some time in the future.
2576 if ( count( $newMessageLinks ) === 1
2577 && $newMessageLinks[0]['wiki'] === wfWikiID()
2578 && $newMessageLinks[0]['rev']
2580 /** @var Revision $newMessageRevision */
2581 $newMessageRevision = $newMessageLinks[0]['rev'];
2582 $newMessageRevisionId = $newMessageRevision->getId();
2585 return $newMessageRevisionId;
2589 * Internal uncached check for new messages
2592 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2593 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2594 * @return bool True if the user has new messages
2596 protected function checkNewtalk( $field, $id ) {
2597 $dbr = wfGetDB( DB_REPLICA
);
2599 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2601 return $ok !== false;
2605 * Add or update the new messages flag
2606 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2607 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2608 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2609 * @return bool True if successful, false otherwise
2611 protected function updateNewtalk( $field, $id, $curRev = null ) {
2612 // Get timestamp of the talk page revision prior to the current one
2613 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2614 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2615 // Mark the user as having new messages since this revision
2616 $dbw = wfGetDB( DB_MASTER
);
2617 $dbw->insert( 'user_newtalk',
2618 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2621 if ( $dbw->affectedRows() ) {
2622 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2625 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2631 * Clear the new messages flag for the given user
2632 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2633 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2634 * @return bool True if successful, false otherwise
2636 protected function deleteNewtalk( $field, $id ) {
2637 $dbw = wfGetDB( DB_MASTER
);
2638 $dbw->delete( 'user_newtalk',
2641 if ( $dbw->affectedRows() ) {
2642 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2645 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2651 * Update the 'You have new messages!' status.
2652 * @param bool $val Whether the user has new messages
2653 * @param Revision $curRev New, as yet unseen revision of the user talk
2654 * page. Ignored if null or !$val.
2656 public function setNewtalk( $val, $curRev = null ) {
2657 if ( wfReadOnly() ) {
2662 $this->mNewtalk
= $val;
2664 if ( $this->isAnon() ) {
2666 $id = $this->getName();
2669 $id = $this->getId();
2673 $changed = $this->updateNewtalk( $field, $id, $curRev );
2675 $changed = $this->deleteNewtalk( $field, $id );
2679 $this->invalidateCache();
2684 * Generate a current or new-future timestamp to be stored in the
2685 * user_touched field when we update things.
2686 * @return string Timestamp in TS_MW format
2688 private function newTouchedTimestamp() {
2689 global $wgClockSkewFudge;
2691 $time = wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2692 if ( $this->mTouched
&& $time <= $this->mTouched
) {
2693 $time = wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2700 * Clear user data from memcached
2702 * Use after applying updates to the database; caller's
2703 * responsibility to update user_touched if appropriate.
2705 * Called implicitly from invalidateCache() and saveSettings().
2707 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2709 public function clearSharedCache( $mode = 'changed' ) {
2710 if ( !$this->getId() ) {
2714 $cache = ObjectCache
::getMainWANInstance();
2715 $key = $this->getCacheKey( $cache );
2716 if ( $mode === 'refresh' ) {
2717 $cache->delete( $key, 1 );
2719 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2720 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2721 $lb->getConnection( DB_MASTER
)->onTransactionPreCommitOrIdle(
2722 function () use ( $cache, $key ) {
2723 $cache->delete( $key );
2728 $cache->delete( $key );
2734 * Immediately touch the user data cache for this account
2736 * Calls touch() and removes account data from memcached
2738 public function invalidateCache() {
2740 $this->clearSharedCache();
2744 * Update the "touched" timestamp for the user
2746 * This is useful on various login/logout events when making sure that
2747 * a browser or proxy that has multiple tenants does not suffer cache
2748 * pollution where the new user sees the old users content. The value
2749 * of getTouched() is checked when determining 304 vs 200 responses.
2750 * Unlike invalidateCache(), this preserves the User object cache and
2751 * avoids database writes.
2755 public function touch() {
2756 $id = $this->getId();
2758 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2759 $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
2760 $cache->touchCheckKey( $key );
2761 $this->mQuickTouched
= null;
2766 * Validate the cache for this account.
2767 * @param string $timestamp A timestamp in TS_MW format
2770 public function validateCache( $timestamp ) {
2771 return ( $timestamp >= $this->getTouched() );
2775 * Get the user touched timestamp
2777 * Use this value only to validate caches via inequalities
2778 * such as in the case of HTTP If-Modified-Since response logic
2780 * @return string TS_MW Timestamp
2782 public function getTouched() {
2786 if ( $this->mQuickTouched
=== null ) {
2787 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2788 $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId
);
2790 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2793 return max( $this->mTouched
, $this->mQuickTouched
);
2796 return $this->mTouched
;
2800 * Get the user_touched timestamp field (time of last DB updates)
2801 * @return string TS_MW Timestamp
2804 public function getDBTouched() {
2807 return $this->mTouched
;
2811 * Set the password and reset the random token.
2812 * Calls through to authentication plugin if necessary;
2813 * will have no effect if the auth plugin refuses to
2814 * pass the change through or if the legal password
2817 * As a special case, setting the password to null
2818 * wipes it, so the account cannot be logged in until
2819 * a new password is set, for instance via e-mail.
2821 * @deprecated since 1.27, use AuthManager instead
2822 * @param string $str New password to set
2823 * @throws PasswordError On failure
2826 public function setPassword( $str ) {
2827 return $this->setPasswordInternal( $str );
2831 * Set the password and reset the random token unconditionally.
2833 * @deprecated since 1.27, use AuthManager instead
2834 * @param string|null $str New password to set or null to set an invalid
2835 * password hash meaning that the user will not be able to log in
2836 * through the web interface.
2838 public function setInternalPassword( $str ) {
2839 $this->setPasswordInternal( $str );
2843 * Actually set the password and such
2844 * @since 1.27 cannot set a password for a user not in the database
2845 * @param string|null $str New password to set or null to set an invalid
2846 * password hash meaning that the user will not be able to log in
2847 * through the web interface.
2848 * @return bool Success
2850 private function setPasswordInternal( $str ) {
2851 $manager = AuthManager
::singleton();
2853 // If the user doesn't exist yet, fail
2854 if ( !$manager->userExists( $this->getName() ) ) {
2855 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2858 $status = $this->changeAuthenticationData( [
2859 'username' => $this->getName(),
2863 if ( !$status->isGood() ) {
2864 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2865 ->info( __METHOD__
. ': Password change rejected: '
2866 . $status->getWikiText( null, null, 'en' ) );
2870 $this->setOption( 'watchlisttoken', false );
2871 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2877 * Changes credentials of the user.
2879 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2880 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2881 * e.g. when no provider handled the change.
2883 * @param array $data A set of authentication data in fieldname => value format. This is the
2884 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2888 public function changeAuthenticationData( array $data ) {
2889 $manager = AuthManager
::singleton();
2890 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2891 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2893 $status = Status
::newGood( 'ignored' );
2894 foreach ( $reqs as $req ) {
2895 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2897 if ( $status->getValue() === 'ignored' ) {
2898 $status->warning( 'authenticationdatachange-ignored' );
2901 if ( $status->isGood() ) {
2902 foreach ( $reqs as $req ) {
2903 $manager->changeAuthenticationData( $req );
2910 * Get the user's current token.
2911 * @param bool $forceCreation Force the generation of a new token if the
2912 * user doesn't have one (default=true for backwards compatibility).
2913 * @return string|null Token
2915 public function getToken( $forceCreation = true ) {
2916 global $wgAuthenticationTokenVersion;
2919 if ( !$this->mToken
&& $forceCreation ) {
2923 if ( !$this->mToken
) {
2924 // The user doesn't have a token, return null to indicate that.
2926 } elseif ( $this->mToken
=== self
::INVALID_TOKEN
) {
2927 // We return a random value here so existing token checks are very
2929 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2930 } elseif ( $wgAuthenticationTokenVersion === null ) {
2931 // $wgAuthenticationTokenVersion not in use, so return the raw secret
2932 return $this->mToken
;
2934 // $wgAuthenticationTokenVersion in use, so hmac it.
2935 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
2937 // The raw hash can be overly long. Shorten it up.
2938 $len = max( 32, self
::TOKEN_LENGTH
);
2939 if ( strlen( $ret ) < $len ) {
2940 // Should never happen, even md5 is 128 bits
2941 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
2943 return substr( $ret, -$len );
2948 * Set the random token (used for persistent authentication)
2949 * Called from loadDefaults() among other places.
2951 * @param string|bool $token If specified, set the token to this value
2953 public function setToken( $token = false ) {
2955 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
2956 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
2957 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
2958 } elseif ( !$token ) {
2959 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2961 $this->mToken
= $token;
2966 * Set the password for a password reminder or new account email
2968 * @deprecated Removed in 1.27. Use PasswordReset instead.
2969 * @param string $str New password to set or null to set an invalid
2970 * password hash meaning that the user will not be able to use it
2971 * @param bool $throttle If true, reset the throttle timestamp to the present
2973 public function setNewpassword( $str, $throttle = true ) {
2974 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2978 * Get the user's e-mail address
2979 * @return string User's email address
2981 public function getEmail() {
2983 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
2984 return $this->mEmail
;
2988 * Get the timestamp of the user's e-mail authentication
2989 * @return string TS_MW timestamp
2991 public function getEmailAuthenticationTimestamp() {
2993 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
2994 return $this->mEmailAuthenticated
;
2998 * Set the user's e-mail address
2999 * @param string $str New e-mail address
3001 public function setEmail( $str ) {
3003 if ( $str == $this->mEmail
) {
3006 $this->invalidateEmail();
3007 $this->mEmail
= $str;
3008 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
3012 * Set the user's e-mail address and a confirmation mail if needed.
3015 * @param string $str New e-mail address
3018 public function setEmailWithConfirmation( $str ) {
3019 global $wgEnableEmail, $wgEmailAuthentication;
3021 if ( !$wgEnableEmail ) {
3022 return Status
::newFatal( 'emaildisabled' );
3025 $oldaddr = $this->getEmail();
3026 if ( $str === $oldaddr ) {
3027 return Status
::newGood( true );
3030 $type = $oldaddr != '' ?
'changed' : 'set';
3031 $notificationResult = null;
3033 if ( $wgEmailAuthentication ) {
3034 // Send the user an email notifying the user of the change in registered
3035 // email address on their previous email address
3036 if ( $type == 'changed' ) {
3037 $change = $str != '' ?
'changed' : 'removed';
3038 $notificationResult = $this->sendMail(
3039 wfMessage( 'notificationemail_subject_' . $change )->text(),
3040 wfMessage( 'notificationemail_body_' . $change,
3041 $this->getRequest()->getIP(),
3048 $this->setEmail( $str );
3050 if ( $str !== '' && $wgEmailAuthentication ) {
3051 // Send a confirmation request to the new address if needed
3052 $result = $this->sendConfirmationMail( $type );
3054 if ( $notificationResult !== null ) {
3055 $result->merge( $notificationResult );
3058 if ( $result->isGood() ) {
3059 // Say to the caller that a confirmation and notification mail has been sent
3060 $result->value
= 'eauth';
3063 $result = Status
::newGood( true );
3070 * Get the user's real name
3071 * @return string User's real name
3073 public function getRealName() {
3074 if ( !$this->isItemLoaded( 'realname' ) ) {
3078 return $this->mRealName
;
3082 * Set the user's real name
3083 * @param string $str New real name
3085 public function setRealName( $str ) {
3087 $this->mRealName
= $str;
3091 * Get the user's current setting for a given option.
3093 * @param string $oname The option to check
3094 * @param string|array $defaultOverride A default value returned if the option does not exist
3095 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
3096 * @return string|array|int|null User's current value for the option
3097 * @see getBoolOption()
3098 * @see getIntOption()
3100 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
3101 global $wgHiddenPrefs;
3102 $this->loadOptions();
3104 # We want 'disabled' preferences to always behave as the default value for
3105 # users, even if they have set the option explicitly in their settings (ie they
3106 # set it, and then it was disabled removing their ability to change it). But
3107 # we don't want to erase the preferences in the database in case the preference
3108 # is re-enabled again. So don't touch $mOptions, just override the returned value
3109 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
3110 return self
::getDefaultOption( $oname );
3113 if ( array_key_exists( $oname, $this->mOptions
) ) {
3114 return $this->mOptions
[$oname];
3116 return $defaultOverride;
3121 * Get all user's options
3123 * @param int $flags Bitwise combination of:
3124 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
3125 * to the default value. (Since 1.25)
3128 public function getOptions( $flags = 0 ) {
3129 global $wgHiddenPrefs;
3130 $this->loadOptions();
3131 $options = $this->mOptions
;
3133 # We want 'disabled' preferences to always behave as the default value for
3134 # users, even if they have set the option explicitly in their settings (ie they
3135 # set it, and then it was disabled removing their ability to change it). But
3136 # we don't want to erase the preferences in the database in case the preference
3137 # is re-enabled again. So don't touch $mOptions, just override the returned value
3138 foreach ( $wgHiddenPrefs as $pref ) {
3139 $default = self
::getDefaultOption( $pref );
3140 if ( $default !== null ) {
3141 $options[$pref] = $default;
3145 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
3146 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
3153 * Get the user's current setting for a given option, as a boolean value.
3155 * @param string $oname The option to check
3156 * @return bool User's current value for the option
3159 public function getBoolOption( $oname ) {
3160 return (bool)$this->getOption( $oname );
3164 * Get the user's current setting for a given option, as an integer value.
3166 * @param string $oname The option to check
3167 * @param int $defaultOverride A default value returned if the option does not exist
3168 * @return int User's current value for the option
3171 public function getIntOption( $oname, $defaultOverride = 0 ) {
3172 $val = $this->getOption( $oname );
3174 $val = $defaultOverride;
3176 return intval( $val );
3180 * Set the given option for a user.
3182 * You need to call saveSettings() to actually write to the database.
3184 * @param string $oname The option to set
3185 * @param mixed $val New value to set
3187 public function setOption( $oname, $val ) {
3188 $this->loadOptions();
3190 // Explicitly NULL values should refer to defaults
3191 if ( is_null( $val ) ) {
3192 $val = self
::getDefaultOption( $oname );
3195 $this->mOptions
[$oname] = $val;
3199 * Get a token stored in the preferences (like the watchlist one),
3200 * resetting it if it's empty (and saving changes).
3202 * @param string $oname The option name to retrieve the token from
3203 * @return string|bool User's current value for the option, or false if this option is disabled.
3204 * @see resetTokenFromOption()
3206 * @deprecated since 1.26 Applications should use the OAuth extension
3208 public function getTokenFromOption( $oname ) {
3209 global $wgHiddenPrefs;
3211 $id = $this->getId();
3212 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
3216 $token = $this->getOption( $oname );
3218 // Default to a value based on the user token to avoid space
3219 // wasted on storing tokens for all users. When this option
3220 // is set manually by the user, only then is it stored.
3221 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
3228 * Reset a token stored in the preferences (like the watchlist one).
3229 * *Does not* save user's preferences (similarly to setOption()).
3231 * @param string $oname The option name to reset the token in
3232 * @return string|bool New token value, or false if this option is disabled.
3233 * @see getTokenFromOption()
3236 public function resetTokenFromOption( $oname ) {
3237 global $wgHiddenPrefs;
3238 if ( in_array( $oname, $wgHiddenPrefs ) ) {
3242 $token = MWCryptRand
::generateHex( 40 );
3243 $this->setOption( $oname, $token );
3248 * Return a list of the types of user options currently returned by
3249 * User::getOptionKinds().
3251 * Currently, the option kinds are:
3252 * - 'registered' - preferences which are registered in core MediaWiki or
3253 * by extensions using the UserGetDefaultOptions hook.
3254 * - 'registered-multiselect' - as above, using the 'multiselect' type.
3255 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
3256 * - 'userjs' - preferences with names starting with 'userjs-', intended to
3257 * be used by user scripts.
3258 * - 'special' - "preferences" that are not accessible via User::getOptions
3259 * or User::setOptions.
3260 * - 'unused' - preferences about which MediaWiki doesn't know anything.
3261 * These are usually legacy options, removed in newer versions.
3263 * The API (and possibly others) use this function to determine the possible
3264 * option types for validation purposes, so make sure to update this when a
3265 * new option kind is added.
3267 * @see User::getOptionKinds
3268 * @return array Option kinds
3270 public static function listOptionKinds() {
3273 'registered-multiselect',
3274 'registered-checkmatrix',
3282 * Return an associative array mapping preferences keys to the kind of a preference they're
3283 * used for. Different kinds are handled differently when setting or reading preferences.
3285 * See User::listOptionKinds for the list of valid option types that can be provided.
3287 * @see User::listOptionKinds
3288 * @param IContextSource $context
3289 * @param array $options Assoc. array with options keys to check as keys.
3290 * Defaults to $this->mOptions.
3291 * @return array The key => kind mapping data
3293 public function getOptionKinds( IContextSource
$context, $options = null ) {
3294 $this->loadOptions();
3295 if ( $options === null ) {
3296 $options = $this->mOptions
;
3299 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
3300 $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
3303 // Pull out the "special" options, so they don't get converted as
3304 // multiselect or checkmatrix.
3305 $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
3306 foreach ( $specialOptions as $name => $value ) {
3307 unset( $prefs[$name] );
3310 // Multiselect and checkmatrix options are stored in the database with
3311 // one key per option, each having a boolean value. Extract those keys.
3312 $multiselectOptions = [];
3313 foreach ( $prefs as $name => $info ) {
3314 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3315 ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField
::class ) ) {
3316 $opts = HTMLFormField
::flattenOptions( $info['options'] );
3317 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
3319 foreach ( $opts as $value ) {
3320 $multiselectOptions["$prefix$value"] = true;
3323 unset( $prefs[$name] );
3326 $checkmatrixOptions = [];
3327 foreach ( $prefs as $name => $info ) {
3328 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3329 ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix
::class ) ) {
3330 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3331 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3332 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
3334 foreach ( $columns as $column ) {
3335 foreach ( $rows as $row ) {
3336 $checkmatrixOptions["$prefix$column-$row"] = true;
3340 unset( $prefs[$name] );
3344 // $value is ignored
3345 foreach ( $options as $key => $value ) {
3346 if ( isset( $prefs[$key] ) ) {
3347 $mapping[$key] = 'registered';
3348 } elseif ( isset( $multiselectOptions[$key] ) ) {
3349 $mapping[$key] = 'registered-multiselect';
3350 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3351 $mapping[$key] = 'registered-checkmatrix';
3352 } elseif ( isset( $specialOptions[$key] ) ) {
3353 $mapping[$key] = 'special';
3354 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3355 $mapping[$key] = 'userjs';
3357 $mapping[$key] = 'unused';
3365 * Reset certain (or all) options to the site defaults
3367 * The optional parameter determines which kinds of preferences will be reset.
3368 * Supported values are everything that can be reported by getOptionKinds()
3369 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3371 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3372 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3373 * for backwards-compatibility.
3374 * @param IContextSource|null $context Context source used when $resetKinds
3375 * does not contain 'all', passed to getOptionKinds().
3376 * Defaults to RequestContext::getMain() when null.
3378 public function resetOptions(
3379 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3380 IContextSource
$context = null
3383 $defaultOptions = self
::getDefaultOptions();
3385 if ( !is_array( $resetKinds ) ) {
3386 $resetKinds = [ $resetKinds ];
3389 if ( in_array( 'all', $resetKinds ) ) {
3390 $newOptions = $defaultOptions;
3392 if ( $context === null ) {
3393 $context = RequestContext
::getMain();
3396 $optionKinds = $this->getOptionKinds( $context );
3397 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3400 // Use default values for the options that should be deleted, and
3401 // copy old values for the ones that shouldn't.
3402 foreach ( $this->mOptions
as $key => $value ) {
3403 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3404 if ( array_key_exists( $key, $defaultOptions ) ) {
3405 $newOptions[$key] = $defaultOptions[$key];
3408 $newOptions[$key] = $value;
3413 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3415 $this->mOptions
= $newOptions;
3416 $this->mOptionsLoaded
= true;
3420 * Get the user's preferred date format.
3421 * @return string User's preferred date format
3423 public function getDatePreference() {
3424 // Important migration for old data rows
3425 if ( is_null( $this->mDatePreference
) ) {
3427 $value = $this->getOption( 'date' );
3428 $map = $wgLang->getDatePreferenceMigrationMap();
3429 if ( isset( $map[$value] ) ) {
3430 $value = $map[$value];
3432 $this->mDatePreference
= $value;
3434 return $this->mDatePreference
;
3438 * Determine based on the wiki configuration and the user's options,
3439 * whether this user must be over HTTPS no matter what.
3443 public function requiresHTTPS() {
3444 global $wgSecureLogin;
3445 if ( !$wgSecureLogin ) {
3448 $https = $this->getBoolOption( 'prefershttps' );
3449 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3451 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3458 * Get the user preferred stub threshold
3462 public function getStubThreshold() {
3463 global $wgMaxArticleSize; # Maximum article size, in Kb
3464 $threshold = $this->getIntOption( 'stubthreshold' );
3465 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3466 // If they have set an impossible value, disable the preference
3467 // so we can use the parser cache again.
3474 * Get the permissions this user has.
3475 * @return string[] permission names
3477 public function getRights() {
3478 if ( is_null( $this->mRights
) ) {
3479 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3480 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3482 // Deny any rights denied by the user's session, unless this
3483 // endpoint has no sessions.
3484 if ( !defined( 'MW_NO_SESSION' ) ) {
3485 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3486 if ( $allowedRights !== null ) {
3487 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3491 // Force reindexation of rights when a hook has unset one of them
3492 $this->mRights
= array_values( array_unique( $this->mRights
) );
3494 // If block disables login, we should also remove any
3495 // extra rights blocked users might have, in case the
3496 // blocked user has a pre-existing session (T129738).
3497 // This is checked here for cases where people only call
3498 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3499 // to give a better error message in the common case.
3500 $config = RequestContext
::getMain()->getConfig();
3502 $this->isLoggedIn() &&
3503 $config->get( 'BlockDisablesLogin' ) &&
3507 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3510 return $this->mRights
;
3514 * Get the list of explicit group memberships this user has.
3515 * The implicit * and user groups are not included.
3516 * @return array Array of String internal group names
3518 public function getGroups() {
3520 $this->loadGroups();
3521 return array_keys( $this->mGroupMemberships
);
3525 * Get the list of explicit group memberships this user has, stored as
3526 * UserGroupMembership objects. Implicit groups are not included.
3528 * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
3531 public function getGroupMemberships() {
3533 $this->loadGroups();
3534 return $this->mGroupMemberships
;
3538 * Get the list of implicit group memberships this user has.
3539 * This includes all explicit groups, plus 'user' if logged in,
3540 * '*' for all accounts, and autopromoted groups
3541 * @param bool $recache Whether to avoid the cache
3542 * @return array Array of String internal group names
3544 public function getEffectiveGroups( $recache = false ) {
3545 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3546 $this->mEffectiveGroups
= array_unique( array_merge(
3547 $this->getGroups(), // explicit groups
3548 $this->getAutomaticGroups( $recache ) // implicit groups
3550 // Avoid PHP 7.1 warning of passing $this by reference
3552 // Hook for additional groups
3553 Hooks
::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups
] );
3554 // Force reindexation of groups when a hook has unset one of them
3555 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3557 return $this->mEffectiveGroups
;
3561 * Get the list of implicit group memberships this user has.
3562 * This includes 'user' if logged in, '*' for all accounts,
3563 * and autopromoted groups
3564 * @param bool $recache Whether to avoid the cache
3565 * @return array Array of String internal group names
3567 public function getAutomaticGroups( $recache = false ) {
3568 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3569 $this->mImplicitGroups
= [ '*' ];
3570 if ( $this->getId() ) {
3571 $this->mImplicitGroups
[] = 'user';
3573 $this->mImplicitGroups
= array_unique( array_merge(
3574 $this->mImplicitGroups
,
3575 Autopromote
::getAutopromoteGroups( $this )
3579 // Assure data consistency with rights/groups,
3580 // as getEffectiveGroups() depends on this function
3581 $this->mEffectiveGroups
= null;
3584 return $this->mImplicitGroups
;
3588 * Returns the groups the user has belonged to.
3590 * The user may still belong to the returned groups. Compare with getGroups().
3592 * The function will not return groups the user had belonged to before MW 1.17
3594 * @return array Names of the groups the user has belonged to.
3596 public function getFormerGroups() {
3599 if ( is_null( $this->mFormerGroups
) ) {
3600 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3601 ?
wfGetDB( DB_MASTER
)
3602 : wfGetDB( DB_REPLICA
);
3603 $res = $db->select( 'user_former_groups',
3605 [ 'ufg_user' => $this->mId
],
3607 $this->mFormerGroups
= [];
3608 foreach ( $res as $row ) {
3609 $this->mFormerGroups
[] = $row->ufg_group
;
3613 return $this->mFormerGroups
;
3617 * Get the user's edit count.
3618 * @return int|null Null for anonymous users
3620 public function getEditCount() {
3621 if ( !$this->getId() ) {
3625 if ( $this->mEditCount
=== null ) {
3626 /* Populate the count, if it has not been populated yet */
3627 $dbr = wfGetDB( DB_REPLICA
);
3628 // check if the user_editcount field has been initialized
3629 $count = $dbr->selectField(
3630 'user', 'user_editcount',
3631 [ 'user_id' => $this->mId
],
3635 if ( $count === null ) {
3636 // it has not been initialized. do so.
3637 $count = $this->initEditCount();
3639 $this->mEditCount
= $count;
3641 return (int)$this->mEditCount
;
3645 * Add the user to the given group. This takes immediate effect.
3646 * If the user is already in the group, the expiry time will be updated to the new
3647 * expiry time. (If $expiry is omitted or null, the membership will be altered to
3650 * @param string $group Name of the group to add
3651 * @param string $expiry Optional expiry timestamp in any format acceptable to
3652 * wfTimestamp(), or null if the group assignment should not expire
3655 public function addGroup( $group, $expiry = null ) {
3657 $this->loadGroups();
3660 $expiry = wfTimestamp( TS_MW
, $expiry );
3663 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
3667 // create the new UserGroupMembership and put it in the DB
3668 $ugm = new UserGroupMembership( $this->mId
, $group, $expiry );
3669 if ( !$ugm->insert( true ) ) {
3673 $this->mGroupMemberships
[$group] = $ugm;
3675 // Refresh the groups caches, and clear the rights cache so it will be
3676 // refreshed on the next call to $this->getRights().
3677 $this->getEffectiveGroups( true );
3678 $this->mRights
= null;
3680 $this->invalidateCache();
3686 * Remove the user from the given group.
3687 * This takes immediate effect.
3688 * @param string $group Name of the group to remove
3691 public function removeGroup( $group ) {
3694 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3698 $ugm = UserGroupMembership
::getMembership( $this->mId
, $group );
3699 // delete the membership entry
3700 if ( !$ugm ||
!$ugm->delete() ) {
3704 $this->loadGroups();
3705 unset( $this->mGroupMemberships
[$group] );
3707 // Refresh the groups caches, and clear the rights cache so it will be
3708 // refreshed on the next call to $this->getRights().
3709 $this->getEffectiveGroups( true );
3710 $this->mRights
= null;
3712 $this->invalidateCache();
3718 * Get whether the user is logged in
3721 public function isLoggedIn() {
3722 return $this->getId() != 0;
3726 * Get whether the user is anonymous
3729 public function isAnon() {
3730 return !$this->isLoggedIn();
3734 * @return bool Whether this user is flagged as being a bot role account
3737 public function isBot() {
3738 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3743 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3749 * Check if user is allowed to access a feature / make an action
3751 * @param string $permissions,... Permissions to test
3752 * @return bool True if user is allowed to perform *any* of the given actions
3754 public function isAllowedAny() {
3755 $permissions = func_get_args();
3756 foreach ( $permissions as $permission ) {
3757 if ( $this->isAllowed( $permission ) ) {
3766 * @param string $permissions,... Permissions to test
3767 * @return bool True if the user is allowed to perform *all* of the given actions
3769 public function isAllowedAll() {
3770 $permissions = func_get_args();
3771 foreach ( $permissions as $permission ) {
3772 if ( !$this->isAllowed( $permission ) ) {
3780 * Internal mechanics of testing a permission
3781 * @param string $action
3784 public function isAllowed( $action = '' ) {
3785 if ( $action === '' ) {
3786 return true; // In the spirit of DWIM
3788 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3789 // by misconfiguration: 0 == 'foo'
3790 return in_array( $action, $this->getRights(), true );
3794 * Check whether to enable recent changes patrol features for this user
3795 * @return bool True or false
3797 public function useRCPatrol() {
3798 global $wgUseRCPatrol;
3799 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3803 * Check whether to enable new pages patrol features for this user
3804 * @return bool True or false
3806 public function useNPPatrol() {
3807 global $wgUseRCPatrol, $wgUseNPPatrol;
3809 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3810 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3815 * Check whether to enable new files patrol features for this user
3816 * @return bool True or false
3818 public function useFilePatrol() {
3819 global $wgUseRCPatrol, $wgUseFilePatrol;
3821 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3822 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3827 * Get the WebRequest object to use with this object
3829 * @return WebRequest
3831 public function getRequest() {
3832 if ( $this->mRequest
) {
3833 return $this->mRequest
;
3841 * Check the watched status of an article.
3842 * @since 1.22 $checkRights parameter added
3843 * @param Title $title Title of the article to look at
3844 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3845 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3848 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3849 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3850 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3857 * @since 1.22 $checkRights parameter added
3858 * @param Title $title Title of the article to look at
3859 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3860 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3862 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3863 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3864 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3866 [ $title->getSubjectPage(), $title->getTalkPage() ]
3869 $this->invalidateCache();
3873 * Stop watching an article.
3874 * @since 1.22 $checkRights parameter added
3875 * @param Title $title Title of the article to look at
3876 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3877 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3879 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3880 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3881 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3882 $store->removeWatch( $this, $title->getSubjectPage() );
3883 $store->removeWatch( $this, $title->getTalkPage() );
3885 $this->invalidateCache();
3889 * Clear the user's notification timestamp for the given title.
3890 * If e-notif e-mails are on, they will receive notification mails on
3891 * the next change of the page if it's watched etc.
3892 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3893 * @param Title &$title Title of the article to look at
3894 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3896 public function clearNotification( &$title, $oldid = 0 ) {
3897 global $wgUseEnotif, $wgShowUpdatedMarker;
3899 // Do nothing if the database is locked to writes
3900 if ( wfReadOnly() ) {
3904 // Do nothing if not allowed to edit the watchlist
3905 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3909 // If we're working on user's talk page, we should update the talk page message indicator
3910 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3911 // Avoid PHP 7.1 warning of passing $this by reference
3913 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
3917 // Try to update the DB post-send and only if needed...
3918 DeferredUpdates
::addCallableUpdate( function () use ( $title, $oldid ) {
3919 if ( !$this->getNewtalk() ) {
3920 return; // no notifications to clear
3923 // Delete the last notifications (they stack up)
3924 $this->setNewtalk( false );
3926 // If there is a new, unseen, revision, use its timestamp
3928 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
3931 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
3936 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3940 if ( $this->isAnon() ) {
3941 // Nothing else to do...
3945 // Only update the timestamp if the page is being watched.
3946 // The query to find out if it is watched is cached both in memcached and per-invocation,
3947 // and when it does have to be executed, it can be on a replica DB
3948 // If this is the user's newtalk page, we always update the timestamp
3950 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3954 MediaWikiServices
::getInstance()->getWatchedItemStore()
3955 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
3959 * Resets all of the given user's page-change notification timestamps.
3960 * If e-notif e-mails are on, they will receive notification mails on
3961 * the next change of any watched page.
3962 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3964 public function clearAllNotifications() {
3965 global $wgUseEnotif, $wgShowUpdatedMarker;
3966 // Do nothing if not allowed to edit the watchlist
3967 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
3971 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3972 $this->setNewtalk( false );
3976 $id = $this->getId();
3981 $watchedItemStore = MediaWikiServices
::getInstance()->getWatchedItemStore();
3982 $watchedItemStore->resetAllNotificationTimestampsForUser( $this );
3984 // We also need to clear here the "you have new message" notification for the own
3985 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
3989 * Compute experienced level based on edit count and registration date.
3991 * @return string 'newcomer', 'learner', or 'experienced'
3993 public function getExperienceLevel() {
3994 global $wgLearnerEdits,
3995 $wgExperiencedUserEdits,
3996 $wgLearnerMemberSince,
3997 $wgExperiencedUserMemberSince;
3999 if ( $this->isAnon() ) {
4003 $editCount = $this->getEditCount();
4004 $registration = $this->getRegistration();
4006 $learnerRegistration = wfTimestamp( TS_MW
, $now - $wgLearnerMemberSince * 86400 );
4007 $experiencedRegistration = wfTimestamp( TS_MW
, $now - $wgExperiencedUserMemberSince * 86400 );
4010 $editCount < $wgLearnerEdits ||
4011 $registration > $learnerRegistration
4015 $editCount > $wgExperiencedUserEdits &&
4016 $registration <= $experiencedRegistration
4018 return 'experienced';
4025 * Persist this user's session (e.g. set cookies)
4027 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
4029 * @param bool $secure Whether to force secure/insecure cookies or use default
4030 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
4032 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
4034 if ( 0 == $this->mId
) {
4038 $session = $this->getRequest()->getSession();
4039 if ( $request && $session->getRequest() !== $request ) {
4040 $session = $session->sessionWithRequest( $request );
4042 $delay = $session->delaySave();
4044 if ( !$session->getUser()->equals( $this ) ) {
4045 if ( !$session->canSetUser() ) {
4046 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4047 ->warning( __METHOD__
.
4048 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
4052 $session->setUser( $this );
4055 $session->setRememberUser( $rememberMe );
4056 if ( $secure !== null ) {
4057 $session->setForceHTTPS( $secure );
4060 $session->persist();
4062 ScopedCallback
::consume( $delay );
4066 * Log this user out.
4068 public function logout() {
4069 // Avoid PHP 7.1 warning of passing $this by reference
4071 if ( Hooks
::run( 'UserLogout', [ &$user ] ) ) {
4077 * Clear the user's session, and reset the instance cache.
4080 public function doLogout() {
4081 $session = $this->getRequest()->getSession();
4082 if ( !$session->canSetUser() ) {
4083 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4084 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
4085 $error = 'immutable';
4086 } elseif ( !$session->getUser()->equals( $this ) ) {
4087 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4088 ->warning( __METHOD__
.
4089 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
4091 // But we still may as well make this user object anon
4092 $this->clearInstanceCache( 'defaults' );
4093 $error = 'wronguser';
4095 $this->clearInstanceCache( 'defaults' );
4096 $delay = $session->delaySave();
4097 $session->unpersist(); // Clear cookies (T127436)
4098 $session->setLoggedOutTimestamp( time() );
4099 $session->setUser( new User
);
4100 $session->set( 'wsUserID', 0 ); // Other code expects this
4101 $session->resetAllTokens();
4102 ScopedCallback
::consume( $delay );
4105 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
4106 'event' => 'logout',
4107 'successful' => $error === false,
4108 'status' => $error ?
: 'success',
4113 * Save this user's settings into the database.
4114 * @todo Only rarely do all these fields need to be set!
4116 public function saveSettings() {
4117 if ( wfReadOnly() ) {
4118 // @TODO: caller should deal with this instead!
4119 // This should really just be an exception.
4120 MWExceptionHandler
::logException( new DBExpectedError(
4122 "Could not update user with ID '{$this->mId}'; DB is read-only."
4128 if ( 0 == $this->mId
) {
4132 // Get a new user_touched that is higher than the old one.
4133 // This will be used for a CAS check as a last-resort safety
4134 // check against race conditions and replica DB lag.
4135 $newTouched = $this->newTouchedTimestamp();
4137 $dbw = wfGetDB( DB_MASTER
);
4138 $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $newTouched ) {
4139 global $wgActorTableSchemaMigrationStage;
4141 $dbw->update( 'user',
4143 'user_name' => $this->mName
,
4144 'user_real_name' => $this->mRealName
,
4145 'user_email' => $this->mEmail
,
4146 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4147 'user_touched' => $dbw->timestamp( $newTouched ),
4148 'user_token' => strval( $this->mToken
),
4149 'user_email_token' => $this->mEmailToken
,
4150 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
4151 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
4152 'user_id' => $this->mId
,
4156 if ( !$dbw->affectedRows() ) {
4157 // Maybe the problem was a missed cache update; clear it to be safe
4158 $this->clearSharedCache( 'refresh' );
4159 // User was changed in the meantime or loaded with stale data
4160 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
4161 throw new MWException(
4162 "CAS update failed on user_touched for user ID '{$this->mId}' (read from $from);" .
4163 " the version of the user to be saved is older than the current version."
4167 if ( $wgActorTableSchemaMigrationStage > MIGRATION_OLD
) {
4170 [ 'actor_name' => $this->mName
],
4171 [ 'actor_user' => $this->mId
],
4177 $this->mTouched
= $newTouched;
4178 $this->saveOptions();
4180 Hooks
::run( 'UserSaveSettings', [ $this ] );
4181 $this->clearSharedCache();
4182 $this->getUserPage()->invalidateCache();
4186 * If only this user's username is known, and it exists, return the user ID.
4188 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
4191 public function idForName( $flags = 0 ) {
4192 $s = trim( $this->getName() );
4197 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
4198 ?
wfGetDB( DB_MASTER
)
4199 : wfGetDB( DB_REPLICA
);
4201 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
4202 ?
[ 'LOCK IN SHARE MODE' ]
4205 $id = $db->selectField( 'user',
4206 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
4212 * Add a user to the database, return the user object
4214 * @param string $name Username to add
4215 * @param array $params Array of Strings Non-default parameters to save to
4216 * the database as user_* fields:
4217 * - email: The user's email address.
4218 * - email_authenticated: The email authentication timestamp.
4219 * - real_name: The user's real name.
4220 * - options: An associative array of non-default options.
4221 * - token: Random authentication token. Do not set.
4222 * - registration: Registration timestamp. Do not set.
4224 * @return User|null User object, or null if the username already exists.
4226 public static function createNew( $name, $params = [] ) {
4227 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
4228 if ( isset( $params[$field] ) ) {
4229 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
4230 unset( $params[$field] );
4236 $user->setToken(); // init token
4237 if ( isset( $params['options'] ) ) {
4238 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
4239 unset( $params['options'] );
4241 $dbw = wfGetDB( DB_MASTER
);
4243 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4246 'user_name' => $name,
4247 'user_password' => $noPass,
4248 'user_newpassword' => $noPass,
4249 'user_email' => $user->mEmail
,
4250 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
4251 'user_real_name' => $user->mRealName
,
4252 'user_token' => strval( $user->mToken
),
4253 'user_registration' => $dbw->timestamp( $user->mRegistration
),
4254 'user_editcount' => 0,
4255 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4257 foreach ( $params as $name => $value ) {
4258 $fields["user_$name"] = $value;
4261 return $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $fields ) {
4262 $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
4263 if ( $dbw->affectedRows() ) {
4264 $newUser = self
::newFromId( $dbw->insertId() );
4265 // Load the user from master to avoid replica lag
4266 $newUser->load( self
::READ_LATEST
);
4267 $newUser->updateActorId( $dbw );
4276 * Add this existing user object to the database. If the user already
4277 * exists, a fatal status object is returned, and the user object is
4278 * initialised with the data from the database.
4280 * Previously, this function generated a DB error due to a key conflict
4281 * if the user already existed. Many extension callers use this function
4282 * in code along the lines of:
4284 * $user = User::newFromName( $name );
4285 * if ( !$user->isLoggedIn() ) {
4286 * $user->addToDatabase();
4288 * // do something with $user...
4290 * However, this was vulnerable to a race condition (T18020). By
4291 * initialising the user object if the user exists, we aim to support this
4292 * calling sequence as far as possible.
4294 * Note that if the user exists, this function will acquire a write lock,
4295 * so it is still advisable to make the call conditional on isLoggedIn(),
4296 * and to commit the transaction after calling.
4298 * @throws MWException
4301 public function addToDatabase() {
4303 if ( !$this->mToken
) {
4304 $this->setToken(); // init token
4307 if ( !is_string( $this->mName
) ) {
4308 throw new RuntimeException( "User name field is not set." );
4311 $this->mTouched
= $this->newTouchedTimestamp();
4313 $dbw = wfGetDB( DB_MASTER
);
4314 $status = $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) {
4315 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4316 $dbw->insert( 'user',
4318 'user_name' => $this->mName
,
4319 'user_password' => $noPass,
4320 'user_newpassword' => $noPass,
4321 'user_email' => $this->mEmail
,
4322 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4323 'user_real_name' => $this->mRealName
,
4324 'user_token' => strval( $this->mToken
),
4325 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4326 'user_editcount' => 0,
4327 'user_touched' => $dbw->timestamp( $this->mTouched
),
4331 if ( !$dbw->affectedRows() ) {
4332 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4333 $this->mId
= $dbw->selectField(
4336 [ 'user_name' => $this->mName
],
4338 [ 'LOCK IN SHARE MODE' ]
4342 if ( $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4347 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
4348 "to insert user '{$this->mName}' row, but it was not present in select!" );
4350 return Status
::newFatal( 'userexists' );
4352 $this->mId
= $dbw->insertId();
4353 self
::$idCacheByName[$this->mName
] = $this->mId
;
4354 $this->updateActorId( $dbw );
4356 return Status
::newGood();
4358 if ( !$status->isGood() ) {
4362 // Clear instance cache other than user table data and actor, which is already accurate
4363 $this->clearInstanceCache();
4365 $this->saveOptions();
4366 return Status
::newGood();
4370 * Update the actor ID after an insert
4371 * @param IDatabase $dbw Writable database handle
4373 private function updateActorId( IDatabase
$dbw ) {
4374 global $wgActorTableSchemaMigrationStage;
4376 if ( $wgActorTableSchemaMigrationStage > MIGRATION_OLD
) {
4379 [ 'actor_user' => $this->mId
, 'actor_name' => $this->mName
],
4382 $this->mActorId
= (int)$dbw->insertId();
4387 * If this user is logged-in and blocked,
4388 * block any IP address they've successfully logged in from.
4389 * @return bool A block was spread
4391 public function spreadAnyEditBlock() {
4392 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4393 return $this->spreadBlock();
4400 * If this (non-anonymous) user is blocked,
4401 * block the IP address they've successfully logged in from.
4402 * @return bool A block was spread
4404 protected function spreadBlock() {
4405 wfDebug( __METHOD__
. "()\n" );
4407 if ( $this->mId
== 0 ) {
4411 $userblock = Block
::newFromTarget( $this->getName() );
4412 if ( !$userblock ) {
4416 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4420 * Get whether the user is explicitly blocked from account creation.
4421 * @return bool|Block
4423 public function isBlockedFromCreateAccount() {
4424 $this->getBlockedStatus();
4425 if ( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
4426 return $this->mBlock
;
4429 # T15611: if the IP address the user is trying to create an account from is
4430 # blocked with createaccount disabled, prevent new account creation there even
4431 # when the user is logged in
4432 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4433 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4435 return $this->mBlockedFromCreateAccount
instanceof Block
4436 && $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
4437 ?
$this->mBlockedFromCreateAccount
4442 * Get whether the user is blocked from using Special:Emailuser.
4445 public function isBlockedFromEmailuser() {
4446 $this->getBlockedStatus();
4447 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
4451 * Get whether the user is allowed to create an account.
4454 public function isAllowedToCreateAccount() {
4455 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4459 * Get this user's personal page title.
4461 * @return Title User's personal page title
4463 public function getUserPage() {
4464 return Title
::makeTitle( NS_USER
, $this->getName() );
4468 * Get this user's talk page title.
4470 * @return Title User's talk page title
4472 public function getTalkPage() {
4473 $title = $this->getUserPage();
4474 return $title->getTalkPage();
4478 * Determine whether the user is a newbie. Newbies are either
4479 * anonymous IPs, or the most recently created accounts.
4482 public function isNewbie() {
4483 return !$this->isAllowed( 'autoconfirmed' );
4487 * Check to see if the given clear-text password is one of the accepted passwords
4488 * @deprecated since 1.27, use AuthManager instead
4489 * @param string $password User password
4490 * @return bool True if the given password is correct, otherwise False
4492 public function checkPassword( $password ) {
4493 $manager = AuthManager
::singleton();
4494 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4495 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4497 'username' => $this->getName(),
4498 'password' => $password,
4501 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4502 switch ( $res->status
) {
4503 case AuthenticationResponse
::PASS
:
4505 case AuthenticationResponse
::FAIL
:
4506 // Hope it's not a PreAuthenticationProvider that failed...
4507 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4508 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4511 throw new BadMethodCallException(
4512 'AuthManager returned a response unsupported by ' . __METHOD__
4518 * Check if the given clear-text password matches the temporary password
4519 * sent by e-mail for password reset operations.
4521 * @deprecated since 1.27, use AuthManager instead
4522 * @param string $plaintext
4523 * @return bool True if matches, false otherwise
4525 public function checkTemporaryPassword( $plaintext ) {
4526 // Can't check the temporary password individually.
4527 return $this->checkPassword( $plaintext );
4531 * Initialize (if necessary) and return a session token value
4532 * which can be used in edit forms to show that the user's
4533 * login credentials aren't being hijacked with a foreign form
4537 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4538 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4539 * @return MediaWiki\Session\Token The new edit token
4541 public function getEditTokenObject( $salt = '', $request = null ) {
4542 if ( $this->isAnon() ) {
4543 return new LoggedOutEditToken();
4547 $request = $this->getRequest();
4549 return $request->getSession()->getToken( $salt );
4553 * Initialize (if necessary) and return a session token value
4554 * which can be used in edit forms to show that the user's
4555 * login credentials aren't being hijacked with a foreign form
4558 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4561 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4562 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4563 * @return string The new edit token
4565 public function getEditToken( $salt = '', $request = null ) {
4566 return $this->getEditTokenObject( $salt, $request )->toString();
4570 * Check given value against the token value stored in the session.
4571 * A match should confirm that the form was submitted from the
4572 * user's own login session, not a form submission from a third-party
4575 * @param string $val Input value to compare
4576 * @param string $salt Optional function-specific data for hashing
4577 * @param WebRequest|null $request Object to use or null to use $wgRequest
4578 * @param int $maxage Fail tokens older than this, in seconds
4579 * @return bool Whether the token matches
4581 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4582 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4586 * Check given value against the token value stored in the session,
4587 * ignoring the suffix.
4589 * @param string $val Input value to compare
4590 * @param string $salt Optional function-specific data for hashing
4591 * @param WebRequest|null $request Object to use or null to use $wgRequest
4592 * @param int $maxage Fail tokens older than this, in seconds
4593 * @return bool Whether the token matches
4595 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4596 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4597 return $this->matchEditToken( $val, $salt, $request, $maxage );
4601 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4602 * mail to the user's given address.
4604 * @param string $type Message to send, either "created", "changed" or "set"
4607 public function sendConfirmationMail( $type = 'created' ) {
4609 $expiration = null; // gets passed-by-ref and defined in next line.
4610 $token = $this->confirmationToken( $expiration );
4611 $url = $this->confirmationTokenUrl( $token );
4612 $invalidateURL = $this->invalidationTokenUrl( $token );
4613 $this->saveSettings();
4615 if ( $type == 'created' ||
$type === false ) {
4616 $message = 'confirmemail_body';
4617 } elseif ( $type === true ) {
4618 $message = 'confirmemail_body_changed';
4620 // Messages: confirmemail_body_changed, confirmemail_body_set
4621 $message = 'confirmemail_body_' . $type;
4624 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4625 wfMessage( $message,
4626 $this->getRequest()->getIP(),
4629 $wgLang->userTimeAndDate( $expiration, $this ),
4631 $wgLang->userDate( $expiration, $this ),
4632 $wgLang->userTime( $expiration, $this ) )->text() );
4636 * Send an e-mail to this user's account. Does not check for
4637 * confirmed status or validity.
4639 * @param string $subject Message subject
4640 * @param string $body Message body
4641 * @param User|null $from Optional sending user; if unspecified, default
4642 * $wgPasswordSender will be used.
4643 * @param string $replyto Reply-To address
4646 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4647 global $wgPasswordSender;
4649 if ( $from instanceof User
) {
4650 $sender = MailAddress
::newFromUser( $from );
4652 $sender = new MailAddress( $wgPasswordSender,
4653 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4655 $to = MailAddress
::newFromUser( $this );
4657 return UserMailer
::send( $to, $sender, $subject, $body, [
4658 'replyTo' => $replyto,
4663 * Generate, store, and return a new e-mail confirmation code.
4664 * A hash (unsalted, since it's used as a key) is stored.
4666 * @note Call saveSettings() after calling this function to commit
4667 * this change to the database.
4669 * @param string &$expiration Accepts the expiration time
4670 * @return string New token
4672 protected function confirmationToken( &$expiration ) {
4673 global $wgUserEmailConfirmationTokenExpiry;
4675 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4676 $expiration = wfTimestamp( TS_MW
, $expires );
4678 $token = MWCryptRand
::generateHex( 32 );
4679 $hash = md5( $token );
4680 $this->mEmailToken
= $hash;
4681 $this->mEmailTokenExpires
= $expiration;
4686 * Return a URL the user can use to confirm their email address.
4687 * @param string $token Accepts the email confirmation token
4688 * @return string New token URL
4690 protected function confirmationTokenUrl( $token ) {
4691 return $this->getTokenUrl( 'ConfirmEmail', $token );
4695 * Return a URL the user can use to invalidate their email address.
4696 * @param string $token Accepts the email confirmation token
4697 * @return string New token URL
4699 protected function invalidationTokenUrl( $token ) {
4700 return $this->getTokenUrl( 'InvalidateEmail', $token );
4704 * Internal function to format the e-mail validation/invalidation URLs.
4705 * This uses a quickie hack to use the
4706 * hardcoded English names of the Special: pages, for ASCII safety.
4708 * @note Since these URLs get dropped directly into emails, using the
4709 * short English names avoids insanely long URL-encoded links, which
4710 * also sometimes can get corrupted in some browsers/mailers
4711 * (T8957 with Gmail and Internet Explorer).
4713 * @param string $page Special page
4714 * @param string $token
4715 * @return string Formatted URL
4717 protected function getTokenUrl( $page, $token ) {
4718 // Hack to bypass localization of 'Special:'
4719 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4720 return $title->getCanonicalURL();
4724 * Mark the e-mail address confirmed.
4726 * @note Call saveSettings() after calling this function to commit the change.
4730 public function confirmEmail() {
4731 // Check if it's already confirmed, so we don't touch the database
4732 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4733 if ( !$this->isEmailConfirmed() ) {
4734 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4735 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4741 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4742 * address if it was already confirmed.
4744 * @note Call saveSettings() after calling this function to commit the change.
4745 * @return bool Returns true
4747 public function invalidateEmail() {
4749 $this->mEmailToken
= null;
4750 $this->mEmailTokenExpires
= null;
4751 $this->setEmailAuthenticationTimestamp( null );
4753 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4758 * Set the e-mail authentication timestamp.
4759 * @param string $timestamp TS_MW timestamp
4761 public function setEmailAuthenticationTimestamp( $timestamp ) {
4763 $this->mEmailAuthenticated
= $timestamp;
4764 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4768 * Is this user allowed to send e-mails within limits of current
4769 * site configuration?
4772 public function canSendEmail() {
4773 global $wgEnableEmail, $wgEnableUserEmail;
4774 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4777 $canSend = $this->isEmailConfirmed();
4778 // Avoid PHP 7.1 warning of passing $this by reference
4780 Hooks
::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
4785 * Is this user allowed to receive e-mails within limits of current
4786 * site configuration?
4789 public function canReceiveEmail() {
4790 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4794 * Is this user's e-mail address valid-looking and confirmed within
4795 * limits of the current site configuration?
4797 * @note If $wgEmailAuthentication is on, this may require the user to have
4798 * confirmed their address by returning a code or using a password
4799 * sent to the address from the wiki.
4803 public function isEmailConfirmed() {
4804 global $wgEmailAuthentication;
4806 // Avoid PHP 7.1 warning of passing $this by reference
4809 if ( Hooks
::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
4810 if ( $this->isAnon() ) {
4813 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4816 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4826 * Check whether there is an outstanding request for e-mail confirmation.
4829 public function isEmailConfirmationPending() {
4830 global $wgEmailAuthentication;
4831 return $wgEmailAuthentication &&
4832 !$this->isEmailConfirmed() &&
4833 $this->mEmailToken
&&
4834 $this->mEmailTokenExpires
> wfTimestamp();
4838 * Get the timestamp of account creation.
4840 * @return string|bool|null Timestamp of account creation, false for
4841 * non-existent/anonymous user accounts, or null if existing account
4842 * but information is not in database.
4844 public function getRegistration() {
4845 if ( $this->isAnon() ) {
4849 return $this->mRegistration
;
4853 * Get the timestamp of the first edit
4855 * @return string|bool Timestamp of first edit, or false for
4856 * non-existent/anonymous user accounts.
4858 public function getFirstEditTimestamp() {
4859 if ( $this->getId() == 0 ) {
4860 return false; // anons
4862 $dbr = wfGetDB( DB_REPLICA
);
4863 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
4864 $time = $dbr->selectField(
4865 [ 'revision' ] +
$actorWhere['tables'],
4867 [ $actorWhere['conds'] ],
4869 [ 'ORDER BY' => 'rev_timestamp ASC' ],
4870 $actorWhere['joins']
4873 return false; // no edits
4875 return wfTimestamp( TS_MW
, $time );
4879 * Get the permissions associated with a given list of groups
4881 * @param array $groups Array of Strings List of internal group names
4882 * @return array Array of Strings List of permission key names for given groups combined
4884 public static function getGroupPermissions( $groups ) {
4885 global $wgGroupPermissions, $wgRevokePermissions;
4887 // grant every granted permission first
4888 foreach ( $groups as $group ) {
4889 if ( isset( $wgGroupPermissions[$group] ) ) {
4890 $rights = array_merge( $rights,
4891 // array_filter removes empty items
4892 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4895 // now revoke the revoked permissions
4896 foreach ( $groups as $group ) {
4897 if ( isset( $wgRevokePermissions[$group] ) ) {
4898 $rights = array_diff( $rights,
4899 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4902 return array_unique( $rights );
4906 * Get all the groups who have a given permission
4908 * @param string $role Role to check
4909 * @return array Array of Strings List of internal group names with the given permission
4911 public static function getGroupsWithPermission( $role ) {
4912 global $wgGroupPermissions;
4913 $allowedGroups = [];
4914 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4915 if ( self
::groupHasPermission( $group, $role ) ) {
4916 $allowedGroups[] = $group;
4919 return $allowedGroups;
4923 * Check, if the given group has the given permission
4925 * If you're wanting to check whether all users have a permission, use
4926 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4930 * @param string $group Group to check
4931 * @param string $role Role to check
4934 public static function groupHasPermission( $group, $role ) {
4935 global $wgGroupPermissions, $wgRevokePermissions;
4936 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4937 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4941 * Check if all users may be assumed to have the given permission
4943 * We generally assume so if the right is granted to '*' and isn't revoked
4944 * on any group. It doesn't attempt to take grants or other extension
4945 * limitations on rights into account in the general case, though, as that
4946 * would require it to always return false and defeat the purpose.
4947 * Specifically, session-based rights restrictions (such as OAuth or bot
4948 * passwords) are applied based on the current session.
4951 * @param string $right Right to check
4954 public static function isEveryoneAllowed( $right ) {
4955 global $wgGroupPermissions, $wgRevokePermissions;
4958 // Use the cached results, except in unit tests which rely on
4959 // being able change the permission mid-request
4960 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
4961 return $cache[$right];
4964 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
4965 $cache[$right] = false;
4969 // If it's revoked anywhere, then everyone doesn't have it
4970 foreach ( $wgRevokePermissions as $rights ) {
4971 if ( isset( $rights[$right] ) && $rights[$right] ) {
4972 $cache[$right] = false;
4977 // Remove any rights that aren't allowed to the global-session user,
4978 // unless there are no sessions for this endpoint.
4979 if ( !defined( 'MW_NO_SESSION' ) ) {
4980 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
4981 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
4982 $cache[$right] = false;
4987 // Allow extensions to say false
4988 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
4989 $cache[$right] = false;
4993 $cache[$right] = true;
4998 * Get the localized descriptive name for a group, if it exists
4999 * @deprecated since 1.29 Use UserGroupMembership::getGroupName instead
5001 * @param string $group Internal group name
5002 * @return string Localized descriptive group name
5004 public static function getGroupName( $group ) {
5005 wfDeprecated( __METHOD__
, '1.29' );
5006 return UserGroupMembership
::getGroupName( $group );
5010 * Get the localized descriptive name for a member of a group, if it exists
5011 * @deprecated since 1.29 Use UserGroupMembership::getGroupMemberName instead
5013 * @param string $group Internal group name
5014 * @param string $username Username for gender (since 1.19)
5015 * @return string Localized name for group member
5017 public static function getGroupMember( $group, $username = '#' ) {
5018 wfDeprecated( __METHOD__
, '1.29' );
5019 return UserGroupMembership
::getGroupMemberName( $group, $username );
5023 * Return the set of defined explicit groups.
5024 * The implicit groups (by default *, 'user' and 'autoconfirmed')
5025 * are not included, as they are defined automatically, not in the database.
5026 * @return array Array of internal group names
5028 public static function getAllGroups() {
5029 global $wgGroupPermissions, $wgRevokePermissions;
5031 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
5032 self
::getImplicitGroups()
5037 * Get a list of all available permissions.
5038 * @return string[] Array of permission names
5040 public static function getAllRights() {
5041 if ( self
::$mAllRights === false ) {
5042 global $wgAvailableRights;
5043 if ( count( $wgAvailableRights ) ) {
5044 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
5046 self
::$mAllRights = self
::$mCoreRights;
5048 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
5050 return self
::$mAllRights;
5054 * Get a list of implicit groups
5055 * @return array Array of Strings Array of internal group names
5057 public static function getImplicitGroups() {
5058 global $wgImplicitGroups;
5060 $groups = $wgImplicitGroups;
5061 # Deprecated, use $wgImplicitGroups instead
5062 Hooks
::run( 'UserGetImplicitGroups', [ &$groups ], '1.25' );
5068 * Get the title of a page describing a particular group
5069 * @deprecated since 1.29 Use UserGroupMembership::getGroupPage instead
5071 * @param string $group Internal group name
5072 * @return Title|bool Title of the page if it exists, false otherwise
5074 public static function getGroupPage( $group ) {
5075 wfDeprecated( __METHOD__
, '1.29' );
5076 return UserGroupMembership
::getGroupPage( $group );
5080 * Create a link to the group in HTML, if available;
5081 * else return the group name.
5082 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5083 * make the link yourself if you need custom text
5085 * @param string $group Internal name of the group
5086 * @param string $text The text of the link
5087 * @return string HTML link to the group
5089 public static function makeGroupLinkHTML( $group, $text = '' ) {
5090 wfDeprecated( __METHOD__
, '1.29' );
5092 if ( $text == '' ) {
5093 $text = UserGroupMembership
::getGroupName( $group );
5095 $title = UserGroupMembership
::getGroupPage( $group );
5097 return MediaWikiServices
::getInstance()
5098 ->getLinkRenderer()->makeLink( $title, $text );
5100 return htmlspecialchars( $text );
5105 * Create a link to the group in Wikitext, if available;
5106 * else return the group name.
5107 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5108 * make the link yourself if you need custom text
5110 * @param string $group Internal name of the group
5111 * @param string $text The text of the link
5112 * @return string Wikilink to the group
5114 public static function makeGroupLinkWiki( $group, $text = '' ) {
5115 wfDeprecated( __METHOD__
, '1.29' );
5117 if ( $text == '' ) {
5118 $text = UserGroupMembership
::getGroupName( $group );
5120 $title = UserGroupMembership
::getGroupPage( $group );
5122 $page = $title->getFullText();
5123 return "[[$page|$text]]";
5130 * Returns an array of the groups that a particular group can add/remove.
5132 * @param string $group The group to check for whether it can add/remove
5133 * @return array Array( 'add' => array( addablegroups ),
5134 * 'remove' => array( removablegroups ),
5135 * 'add-self' => array( addablegroups to self),
5136 * 'remove-self' => array( removable groups from self) )
5138 public static function changeableByGroup( $group ) {
5139 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
5148 if ( empty( $wgAddGroups[$group] ) ) {
5149 // Don't add anything to $groups
5150 } elseif ( $wgAddGroups[$group] === true ) {
5151 // You get everything
5152 $groups['add'] = self
::getAllGroups();
5153 } elseif ( is_array( $wgAddGroups[$group] ) ) {
5154 $groups['add'] = $wgAddGroups[$group];
5157 // Same thing for remove
5158 if ( empty( $wgRemoveGroups[$group] ) ) {
5160 } elseif ( $wgRemoveGroups[$group] === true ) {
5161 $groups['remove'] = self
::getAllGroups();
5162 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
5163 $groups['remove'] = $wgRemoveGroups[$group];
5166 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
5167 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
5168 foreach ( $wgGroupsAddToSelf as $key => $value ) {
5169 if ( is_int( $key ) ) {
5170 $wgGroupsAddToSelf['user'][] = $value;
5175 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
5176 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
5177 if ( is_int( $key ) ) {
5178 $wgGroupsRemoveFromSelf['user'][] = $value;
5183 // Now figure out what groups the user can add to him/herself
5184 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
5186 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
5187 // No idea WHY this would be used, but it's there
5188 $groups['add-self'] = self
::getAllGroups();
5189 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
5190 $groups['add-self'] = $wgGroupsAddToSelf[$group];
5193 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
5195 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
5196 $groups['remove-self'] = self
::getAllGroups();
5197 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
5198 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
5205 * Returns an array of groups that this user can add and remove
5206 * @return array Array( 'add' => array( addablegroups ),
5207 * 'remove' => array( removablegroups ),
5208 * 'add-self' => array( addablegroups to self),
5209 * 'remove-self' => array( removable groups from self) )
5211 public function changeableGroups() {
5212 if ( $this->isAllowed( 'userrights' ) ) {
5213 // This group gives the right to modify everything (reverse-
5214 // compatibility with old "userrights lets you change
5216 // Using array_merge to make the groups reindexed
5217 $all = array_merge( self
::getAllGroups() );
5226 // Okay, it's not so simple, we will have to go through the arrays
5233 $addergroups = $this->getEffectiveGroups();
5235 foreach ( $addergroups as $addergroup ) {
5236 $groups = array_merge_recursive(
5237 $groups, $this->changeableByGroup( $addergroup )
5239 $groups['add'] = array_unique( $groups['add'] );
5240 $groups['remove'] = array_unique( $groups['remove'] );
5241 $groups['add-self'] = array_unique( $groups['add-self'] );
5242 $groups['remove-self'] = array_unique( $groups['remove-self'] );
5248 * Deferred version of incEditCountImmediate()
5250 * This function, rather than incEditCountImmediate(), should be used for
5251 * most cases as it avoids potential deadlocks caused by concurrent editing.
5253 public function incEditCount() {
5254 wfGetDB( DB_MASTER
)->onTransactionPreCommitOrIdle(
5256 $this->incEditCountImmediate();
5263 * Increment the user's edit-count field.
5264 * Will have no effect for anonymous users.
5267 public function incEditCountImmediate() {
5268 if ( $this->isAnon() ) {
5272 $dbw = wfGetDB( DB_MASTER
);
5273 // No rows will be "affected" if user_editcount is NULL
5276 [ 'user_editcount=user_editcount+1' ],
5277 [ 'user_id' => $this->getId(), 'user_editcount IS NOT NULL' ],
5280 // Lazy initialization check...
5281 if ( $dbw->affectedRows() == 0 ) {
5282 // Now here's a goddamn hack...
5283 $dbr = wfGetDB( DB_REPLICA
);
5284 if ( $dbr !== $dbw ) {
5285 // If we actually have a replica DB server, the count is
5286 // at least one behind because the current transaction
5287 // has not been committed and replicated.
5288 $this->mEditCount
= $this->initEditCount( 1 );
5290 // But if DB_REPLICA is selecting the master, then the
5291 // count we just read includes the revision that was
5292 // just added in the working transaction.
5293 $this->mEditCount
= $this->initEditCount();
5296 if ( $this->mEditCount
=== null ) {
5297 $this->getEditCount();
5298 $dbr = wfGetDB( DB_REPLICA
);
5299 $this->mEditCount +
= ( $dbr !== $dbw ) ?
1 : 0;
5301 $this->mEditCount++
;
5304 // Edit count in user cache too
5305 $this->invalidateCache();
5309 * Initialize user_editcount from data out of the revision table
5311 * @param int $add Edits to add to the count from the revision table
5312 * @return int Number of edits
5314 protected function initEditCount( $add = 0 ) {
5315 // Pull from a replica DB to be less cruel to servers
5316 // Accuracy isn't the point anyway here
5317 $dbr = wfGetDB( DB_REPLICA
);
5318 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5319 $count = (int)$dbr->selectField(
5320 [ 'revision' ] +
$actorWhere['tables'],
5322 [ $actorWhere['conds'] ],
5325 $actorWhere['joins']
5327 $count = $count +
$add;
5329 $dbw = wfGetDB( DB_MASTER
);
5332 [ 'user_editcount' => $count ],
5333 [ 'user_id' => $this->getId() ],
5341 * Get the description of a given right
5344 * @param string $right Right to query
5345 * @return string Localized description of the right
5347 public static function getRightDescription( $right ) {
5348 $key = "right-$right";
5349 $msg = wfMessage( $key );
5350 return $msg->isDisabled() ?
$right : $msg->text();
5354 * Get the name of a given grant
5357 * @param string $grant Grant to query
5358 * @return string Localized name of the grant
5360 public static function getGrantName( $grant ) {
5361 $key = "grant-$grant";
5362 $msg = wfMessage( $key );
5363 return $msg->isDisabled() ?
$grant : $msg->text();
5367 * Add a newuser log entry for this user.
5368 * Before 1.19 the return value was always true.
5370 * @deprecated since 1.27, AuthManager handles logging
5371 * @param string|bool $action Account creation type.
5372 * - String, one of the following values:
5373 * - 'create' for an anonymous user creating an account for himself.
5374 * This will force the action's performer to be the created user itself,
5375 * no matter the value of $wgUser
5376 * - 'create2' for a logged in user creating an account for someone else
5377 * - 'byemail' when the created user will receive its password by e-mail
5378 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5379 * - Boolean means whether the account was created by e-mail (deprecated):
5380 * - true will be converted to 'byemail'
5381 * - false will be converted to 'create' if this object is the same as
5382 * $wgUser and to 'create2' otherwise
5383 * @param string $reason User supplied reason
5386 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5387 return true; // disabled
5391 * Add an autocreate newuser log entry for this user
5392 * Used by things like CentralAuth and perhaps other authplugins.
5393 * Consider calling addNewUserLogEntry() directly instead.
5395 * @deprecated since 1.27, AuthManager handles logging
5398 public function addNewUserLogEntryAutoCreate() {
5399 $this->addNewUserLogEntry( 'autocreate' );
5405 * Load the user options either from cache, the database or an array
5407 * @param array $data Rows for the current user out of the user_properties table
5409 protected function loadOptions( $data = null ) {
5414 if ( $this->mOptionsLoaded
) {
5418 $this->mOptions
= self
::getDefaultOptions();
5420 if ( !$this->getId() ) {
5421 // For unlogged-in users, load language/variant options from request.
5422 // There's no need to do it for logged-in users: they can set preferences,
5423 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5424 // so don't override user's choice (especially when the user chooses site default).
5425 $variant = $wgContLang->getDefaultVariant();
5426 $this->mOptions
['variant'] = $variant;
5427 $this->mOptions
['language'] = $variant;
5428 $this->mOptionsLoaded
= true;
5432 // Maybe load from the object
5433 if ( !is_null( $this->mOptionOverrides
) ) {
5434 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5435 foreach ( $this->mOptionOverrides
as $key => $value ) {
5436 $this->mOptions
[$key] = $value;
5439 if ( !is_array( $data ) ) {
5440 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5441 // Load from database
5442 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5443 ?
wfGetDB( DB_MASTER
)
5444 : wfGetDB( DB_REPLICA
);
5446 $res = $dbr->select(
5448 [ 'up_property', 'up_value' ],
5449 [ 'up_user' => $this->getId() ],
5453 $this->mOptionOverrides
= [];
5455 foreach ( $res as $row ) {
5456 // Convert '0' to 0. PHP's boolean conversion considers them both
5457 // false, but e.g. JavaScript considers the former as true.
5458 // @todo: T54542 Somehow determine the desired type (string/int/bool)
5459 // and convert all values here.
5460 if ( $row->up_value
=== '0' ) {
5463 $data[$row->up_property
] = $row->up_value
;
5467 // Convert the email blacklist from a new line delimited string
5468 // to an array of ids.
5469 if ( isset( $data['email-blacklist'] ) && $data['email-blacklist'] ) {
5470 $data['email-blacklist'] = array_map( 'intval', explode( "\n", $data['email-blacklist'] ) );
5473 foreach ( $data as $property => $value ) {
5474 $this->mOptionOverrides
[$property] = $value;
5475 $this->mOptions
[$property] = $value;
5479 $this->mOptionsLoaded
= true;
5481 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5485 * Saves the non-default options for this user, as previously set e.g. via
5486 * setOption(), in the database's "user_properties" (preferences) table.
5487 * Usually used via saveSettings().
5489 protected function saveOptions() {
5490 $this->loadOptions();
5492 // Not using getOptions(), to keep hidden preferences in database
5493 $saveOptions = $this->mOptions
;
5495 // Convert usernames to ids.
5496 if ( isset( $this->mOptions
['email-blacklist'] ) ) {
5497 if ( $this->mOptions
['email-blacklist'] ) {
5498 $value = $this->mOptions
['email-blacklist'];
5499 // Email Blacklist may be an array of ids or a string of new line
5500 // delimnated user names.
5501 if ( is_array( $value ) ) {
5502 $ids = array_filter( $value, 'is_numeric' );
5504 $lookup = CentralIdLookup
::factory();
5505 $ids = $lookup->centralIdsFromNames( explode( "\n", $value ), $this );
5507 $this->mOptions
['email-blacklist'] = $ids;
5508 $saveOptions['email-blacklist'] = implode( "\n", $this->mOptions
['email-blacklist'] );
5510 // If the blacklist is empty, set it to null rather than an empty string.
5511 $this->mOptions
['email-blacklist'] = null;
5515 // Allow hooks to abort, for instance to save to a global profile.
5516 // Reset options to default state before saving.
5517 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5521 $userId = $this->getId();
5523 $insert_rows = []; // all the new preference rows
5524 foreach ( $saveOptions as $key => $value ) {
5525 // Don't bother storing default values
5526 $defaultOption = self
::getDefaultOption( $key );
5527 if ( ( $defaultOption === null && $value !== false && $value !== null )
5528 ||
$value != $defaultOption
5531 'up_user' => $userId,
5532 'up_property' => $key,
5533 'up_value' => $value,
5538 $dbw = wfGetDB( DB_MASTER
);
5540 $res = $dbw->select( 'user_properties',
5541 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5543 // Find prior rows that need to be removed or updated. These rows will
5544 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5546 foreach ( $res as $row ) {
5547 if ( !isset( $saveOptions[$row->up_property
] )
5548 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5550 $keysDelete[] = $row->up_property
;
5554 if ( count( $keysDelete ) ) {
5555 // Do the DELETE by PRIMARY KEY for prior rows.
5556 // In the past a very large portion of calls to this function are for setting
5557 // 'rememberpassword' for new accounts (a preference that has since been removed).
5558 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5559 // caused gap locks on [max user ID,+infinity) which caused high contention since
5560 // updates would pile up on each other as they are for higher (newer) user IDs.
5561 // It might not be necessary these days, but it shouldn't hurt either.
5562 $dbw->delete( 'user_properties',
5563 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5565 // Insert the new preference rows
5566 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5570 * Return the list of user fields that should be selected to create
5571 * a new user object.
5572 * @deprecated since 1.31, use self::getQueryInfo() instead.
5575 public static function selectFields() {
5576 wfDeprecated( __METHOD__
, '1.31' );
5584 'user_email_authenticated',
5586 'user_email_token_expires',
5587 'user_registration',
5593 * Return the tables, fields, and join conditions to be selected to create
5594 * a new user object.
5596 * @return array With three keys:
5597 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
5598 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
5599 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
5601 public static function getQueryInfo() {
5602 global $wgActorTableSchemaMigrationStage;
5605 'tables' => [ 'user' ],
5613 'user_email_authenticated',
5615 'user_email_token_expires',
5616 'user_registration',
5621 if ( $wgActorTableSchemaMigrationStage > MIGRATION_OLD
) {
5622 $ret['tables']['user_actor'] = 'actor';
5623 $ret['fields'][] = 'user_actor.actor_id';
5624 $ret['joins']['user_actor'] = [
5625 $wgActorTableSchemaMigrationStage === MIGRATION_NEW ?
'JOIN' : 'LEFT JOIN',
5626 [ 'user_actor.actor_user = user_id' ]
5633 * Factory function for fatal permission-denied errors
5636 * @param string $permission User right required
5639 static function newFatalPermissionDeniedStatus( $permission ) {
5643 foreach ( self
::getGroupsWithPermission( $permission ) as $group ) {
5644 $groups[] = UserGroupMembership
::getLink( $group, RequestContext
::getMain(), 'wiki' );
5648 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5650 return Status
::newFatal( 'badaccess-group0' );
5655 * Get a new instance of this user that was loaded from the master via a locking read
5657 * Use this instead of the main context User when updating that user. This avoids races
5658 * where that user was loaded from a replica DB or even the master but without proper locks.
5660 * @return User|null Returns null if the user was not found in the DB
5663 public function getInstanceForUpdate() {
5664 if ( !$this->getId() ) {
5665 return null; // anon
5668 $user = self
::newFromId( $this->getId() );
5669 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5677 * Checks if two user objects point to the same user.
5683 public function equals( User
$user ) {
5684 return $this->getName() === $user->getName();