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
;
36 * String Some punctuation to prevent editing from broken text-mangling proxies.
37 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
40 define( 'EDIT_TOKEN_SUFFIX', Token
::SUFFIX
);
43 * The User object encapsulates all of the user-specific settings (user_id,
44 * name, rights, email address, options, last login time). Client
45 * classes use the getXXX() functions to access these fields. These functions
46 * do all the work of determining whether the user is logged in,
47 * whether the requested option can be satisfied from cookies or
48 * whether a database query is needed. Most of the settings needed
49 * for rendering normal pages are set in the cookie to minimize use
52 class User
implements IDBAccessObject
, UserIdentity
{
54 * @const int Number of characters in user_token field.
56 const TOKEN_LENGTH
= 32;
59 * @const string An invalid value for user_token
61 const INVALID_TOKEN
= '*** INVALID ***';
64 * Global constant made accessible as class constants so that autoloader
66 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
68 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
71 * @const int Serialized record version.
76 * Exclude user options that are set to their default value.
79 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
84 const CHECK_USER_RIGHTS
= true;
89 const IGNORE_USER_RIGHTS
= false;
92 * Array of Strings List of member variables which are saved to the
93 * shared cache (memcached). Any operation which changes the
94 * corresponding database fields must call a cache-clearing function.
97 protected static $mCacheVars = [
105 'mEmailAuthenticated',
107 'mEmailTokenExpires',
112 // user_properties table
117 * Array of Strings Core rights.
118 * Each of these should have a corresponding message of the form
122 protected static $mCoreRights = [
165 'move-categorypages',
166 'move-rootuserpages',
170 'override-export-depth',
192 'userrights-interwiki',
200 * String Cached results of getAllRights()
202 protected static $mAllRights = false;
204 /** Cache variables */
215 /** @var string TS_MW timestamp from the DB */
217 /** @var string TS_MW timestamp from cache */
218 protected $mQuickTouched;
222 public $mEmailAuthenticated;
224 protected $mEmailToken;
226 protected $mEmailTokenExpires;
228 protected $mRegistration;
230 protected $mEditCount;
231 /** @var UserGroupMembership[] Associative array of (group name => UserGroupMembership object) */
232 protected $mGroupMemberships;
234 protected $mOptionOverrides;
238 * Bool Whether the cache variables have been loaded.
241 public $mOptionsLoaded;
244 * Array with already loaded items or true if all items have been loaded.
246 protected $mLoadedItems = [];
250 * String Initialization data source if mLoadedItems!==true. May be one of:
251 * - 'defaults' anonymous user initialised from class defaults
252 * - 'name' initialise from mName
253 * - 'id' initialise from mId
254 * - 'session' log in from session if possible
256 * Use the User::newFrom*() family of functions to set this.
261 * Lazy-initialized variables, invalidated with clearInstanceCache
265 protected $mDatePreference;
273 protected $mBlockreason;
275 protected $mEffectiveGroups;
277 protected $mImplicitGroups;
279 protected $mFormerGroups;
281 protected $mGlobalBlock;
289 /** @var WebRequest */
296 protected $mAllowUsertalk;
299 private $mBlockedFromCreateAccount = false;
301 /** @var int User::READ_* constant bitfield used to load data */
302 protected $queryFlagsUsed = self
::READ_NORMAL
;
304 public static $idCacheByName = [];
307 * Lightweight constructor for an anonymous user.
308 * Use the User::newFrom* factory functions for other kinds of users.
312 * @see newFromConfirmationCode()
313 * @see newFromSession()
316 public function __construct() {
317 $this->clearInstanceCache( 'defaults' );
323 public function __toString() {
324 return (string)$this->getName();
328 * Test if it's safe to load this User object.
330 * You should typically check this before using $wgUser or
331 * RequestContext::getUser in a method that might be called before the
332 * system has been fully initialized. If the object is unsafe, you should
333 * use an anonymous user:
335 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
341 public function isSafeToLoad() {
342 global $wgFullyInitialised;
344 // The user is safe to load if:
345 // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
346 // * mLoadedItems === true (already loaded)
347 // * mFrom !== 'session' (sessions not involved at all)
349 return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
350 $this->mLoadedItems
=== true ||
$this->mFrom
!== 'session';
354 * Load the user table data for this object from the source given by mFrom.
356 * @param int $flags User::READ_* constant bitfield
358 public function load( $flags = self
::READ_NORMAL
) {
359 global $wgFullyInitialised;
361 if ( $this->mLoadedItems
=== true ) {
365 // Set it now to avoid infinite recursion in accessors
366 $oldLoadedItems = $this->mLoadedItems
;
367 $this->mLoadedItems
= true;
368 $this->queryFlagsUsed
= $flags;
370 // If this is called too early, things are likely to break.
371 if ( !$wgFullyInitialised && $this->mFrom
=== 'session' ) {
372 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
373 ->warning( 'User::loadFromSession called before the end of Setup.php', [
374 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
376 $this->loadDefaults();
377 $this->mLoadedItems
= $oldLoadedItems;
381 switch ( $this->mFrom
) {
383 $this->loadDefaults();
386 // Make sure this thread sees its own changes
387 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
388 if ( $lb->hasOrMadeRecentMasterChanges() ) {
389 $flags |
= self
::READ_LATEST
;
390 $this->queryFlagsUsed
= $flags;
393 $this->mId
= self
::idFromName( $this->mName
, $flags );
395 // Nonexistent user placeholder object
396 $this->loadDefaults( $this->mName
);
398 $this->loadFromId( $flags );
402 $this->loadFromId( $flags );
405 if ( !$this->loadFromSession() ) {
406 // Loading from session failed. Load defaults.
407 $this->loadDefaults();
409 Hooks
::run( 'UserLoadAfterLoadFromSession', [ $this ] );
412 throw new UnexpectedValueException(
413 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
418 * Load user table data, given mId has already been set.
419 * @param int $flags User::READ_* constant bitfield
420 * @return bool False if the ID does not exist, true otherwise
422 public function loadFromId( $flags = self
::READ_NORMAL
) {
423 if ( $this->mId
== 0 ) {
424 // Anonymous users are not in the database (don't need cache)
425 $this->loadDefaults();
429 // Try cache (unless this needs data from the master DB).
430 // NOTE: if this thread called saveSettings(), the cache was cleared.
431 $latest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
433 if ( !$this->loadFromDatabase( $flags ) ) {
434 // Can't load from ID
438 $this->loadFromCache();
441 $this->mLoadedItems
= true;
442 $this->queryFlagsUsed
= $flags;
449 * @param string $wikiId
452 public static function purge( $wikiId, $userId ) {
453 $cache = ObjectCache
::getMainWANInstance();
454 $key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
455 $cache->delete( $key );
460 * @param WANObjectCache $cache
463 protected function getCacheKey( WANObjectCache
$cache ) {
464 return $cache->makeGlobalKey( 'user', 'id', wfWikiID(), $this->mId
);
468 * @param WANObjectCache $cache
472 public function getMutableCacheKeys( WANObjectCache
$cache ) {
473 $id = $this->getId();
475 return $id ?
[ $this->getCacheKey( $cache ) ] : [];
479 * Load user data from shared cache, given mId has already been set.
484 protected function loadFromCache() {
485 $cache = ObjectCache
::getMainWANInstance();
486 $data = $cache->getWithSetCallback(
487 $this->getCacheKey( $cache ),
489 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
490 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
491 wfDebug( "User: cache miss for user {$this->mId}\n" );
493 $this->loadFromDatabase( self
::READ_NORMAL
);
495 $this->loadOptions();
498 foreach ( self
::$mCacheVars as $name ) {
499 $data[$name] = $this->$name;
502 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->mTouched
), $ttl );
504 // if a user group membership is about to expire, the cache needs to
505 // expire at that time (T163691)
506 foreach ( $this->mGroupMemberships
as $ugm ) {
507 if ( $ugm->getExpiry() ) {
508 $secondsUntilExpiry = wfTimestamp( TS_UNIX
, $ugm->getExpiry() ) - time();
509 if ( $secondsUntilExpiry > 0 && $secondsUntilExpiry < $ttl ) {
510 $ttl = $secondsUntilExpiry;
517 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'version' => self
::VERSION
]
520 // Restore from cache
521 foreach ( self
::$mCacheVars as $name ) {
522 $this->$name = $data[$name];
528 /** @name newFrom*() static factory methods */
532 * Static factory method for creation from username.
534 * This is slightly less efficient than newFromId(), so use newFromId() if
535 * you have both an ID and a name handy.
537 * @param string $name Username, validated by Title::newFromText()
538 * @param string|bool $validate Validate username. Takes the same parameters as
539 * User::getCanonicalName(), except that true is accepted as an alias
540 * for 'valid', for BC.
542 * @return User|bool User object, or false if the username is invalid
543 * (e.g. if it contains illegal characters or is an IP address). If the
544 * username is not present in the database, the result will be a user object
545 * with a name, zero user ID and default settings.
547 public static function newFromName( $name, $validate = 'valid' ) {
548 if ( $validate === true ) {
551 $name = self
::getCanonicalName( $name, $validate );
552 if ( $name === false ) {
555 // Create unloaded user object
559 $u->setItemLoaded( 'name' );
565 * Static factory method for creation from a given user ID.
567 * @param int $id Valid user ID
568 * @return User The corresponding User object
570 public static function newFromId( $id ) {
574 $u->setItemLoaded( 'id' );
579 * Factory method to fetch whichever user has a given email confirmation code.
580 * This code is generated when an account is created or its e-mail address
583 * If the code is invalid or has expired, returns NULL.
585 * @param string $code Confirmation code
586 * @param int $flags User::READ_* bitfield
589 public static function newFromConfirmationCode( $code, $flags = 0 ) {
590 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
591 ?
wfGetDB( DB_MASTER
)
592 : wfGetDB( DB_REPLICA
);
594 $id = $db->selectField(
598 'user_email_token' => md5( $code ),
599 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
603 return $id ? self
::newFromId( $id ) : null;
607 * Create a new user object using data from session. If the login
608 * credentials are invalid, the result is an anonymous user.
610 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
613 public static function newFromSession( WebRequest
$request = null ) {
615 $user->mFrom
= 'session';
616 $user->mRequest
= $request;
621 * Create a new user object from a user row.
622 * The row should have the following fields from the user table in it:
623 * - either user_name or user_id to load further data if needed (or both)
625 * - all other fields (email, etc.)
626 * It is useless to provide the remaining fields if either user_id,
627 * user_name and user_real_name are not provided because the whole row
628 * will be loaded once more from the database when accessing them.
630 * @param stdClass $row A row from the user table
631 * @param array $data Further data to load into the object (see User::loadFromRow for valid keys)
634 public static function newFromRow( $row, $data = null ) {
636 $user->loadFromRow( $row, $data );
641 * Static factory method for creation of a "system" user from username.
643 * A "system" user is an account that's used to attribute logged actions
644 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
645 * might include the 'Maintenance script' or 'Conversion script' accounts
646 * used by various scripts in the maintenance/ directory or accounts such
647 * as 'MediaWiki message delivery' used by the MassMessage extension.
649 * This can optionally create the user if it doesn't exist, and "steal" the
650 * account if it does exist.
652 * "Stealing" an existing user is intended to make it impossible for normal
653 * authentication processes to use the account, effectively disabling the
654 * account for normal use:
655 * - Email is invalidated, to prevent account recovery by emailing a
656 * temporary password and to disassociate the account from the existing
658 * - The token is set to a magic invalid value, to kill existing sessions
659 * and to prevent $this->setToken() calls from resetting the token to a
661 * - SessionManager is instructed to prevent new sessions for the user, to
662 * do things like deauthorizing OAuth consumers.
663 * - AuthManager is instructed to revoke access, to invalidate or remove
664 * passwords and other credentials.
666 * @param string $name Username
667 * @param array $options Options are:
668 * - validate: As for User::getCanonicalName(), default 'valid'
669 * - create: Whether to create the user if it doesn't already exist, default true
670 * - steal: Whether to "disable" the account for normal use if it already
671 * exists, default false
675 public static function newSystemUser( $name, $options = [] ) {
677 'validate' => 'valid',
682 $name = self
::getCanonicalName( $name, $options['validate'] );
683 if ( $name === false ) {
687 $dbr = wfGetDB( DB_REPLICA
);
688 $userQuery = self
::getQueryInfo();
689 $row = $dbr->selectRow(
690 $userQuery['tables'],
691 $userQuery['fields'],
692 [ 'user_name' => $name ],
698 // Try the master database...
699 $dbw = wfGetDB( DB_MASTER
);
700 $row = $dbw->selectRow(
701 $userQuery['tables'],
702 $userQuery['fields'],
703 [ 'user_name' => $name ],
711 // No user. Create it?
712 return $options['create']
713 ? self
::createNew( $name, [ 'token' => self
::INVALID_TOKEN
] )
717 $user = self
::newFromRow( $row );
719 // A user is considered to exist as a non-system user if it can
720 // authenticate, or has an email set, or has a non-invalid token.
721 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
722 AuthManager
::singleton()->userCanAuthenticate( $name )
724 // User exists. Steal it?
725 if ( !$options['steal'] ) {
729 AuthManager
::singleton()->revokeAccessForUser( $name );
731 $user->invalidateEmail();
732 $user->mToken
= self
::INVALID_TOKEN
;
733 $user->saveSettings();
734 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
743 * Get the username corresponding to a given user ID
744 * @param int $id User ID
745 * @return string|bool The corresponding username
747 public static function whoIs( $id ) {
748 return UserCache
::singleton()->getProp( $id, 'name' );
752 * Get the real name of a user given their user ID
754 * @param int $id User ID
755 * @return string|bool The corresponding user's real name
757 public static function whoIsReal( $id ) {
758 return UserCache
::singleton()->getProp( $id, 'real_name' );
762 * Get database id given a user name
763 * @param string $name Username
764 * @param int $flags User::READ_* constant bitfield
765 * @return int|null The corresponding user's ID, or null if user is nonexistent
767 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
768 $nt = Title
::makeTitleSafe( NS_USER
, $name );
769 if ( is_null( $nt ) ) {
774 if ( !( $flags & self
::READ_LATEST
) && isset( self
::$idCacheByName[$name] ) ) {
775 return self
::$idCacheByName[$name];
778 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
779 $db = wfGetDB( $index );
784 [ 'user_name' => $nt->getText() ],
789 if ( $s === false ) {
792 $result = $s->user_id
;
795 self
::$idCacheByName[$name] = $result;
797 if ( count( self
::$idCacheByName ) > 1000 ) {
798 self
::$idCacheByName = [];
805 * Reset the cache used in idFromName(). For use in tests.
807 public static function resetIdByNameCache() {
808 self
::$idCacheByName = [];
812 * Does the string match an anonymous IP address?
814 * This function exists for username validation, in order to reject
815 * usernames which are similar in form to IP addresses. Strings such
816 * as 300.300.300.300 will return true because it looks like an IP
817 * address, despite not being strictly valid.
819 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
820 * address because the usemod software would "cloak" anonymous IP
821 * addresses like this, if we allowed accounts like this to be created
822 * new users could get the old edits of these anonymous users.
824 * @param string $name Name to match
827 public static function isIP( $name ) {
828 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
829 || IP
::isIPv6( $name );
833 * Is the user an IP range?
838 public function isIPRange() {
839 return IP
::isValidRange( $this->mName
);
843 * Is the input a valid username?
845 * Checks if the input is a valid username, we don't want an empty string,
846 * an IP address, anything that contains slashes (would mess up subpages),
847 * is longer than the maximum allowed username size or doesn't begin with
850 * @param string $name Name to match
853 public static function isValidUserName( $name ) {
854 global $wgContLang, $wgMaxNameChars;
857 || self
::isIP( $name )
858 ||
strpos( $name, '/' ) !== false
859 ||
strlen( $name ) > $wgMaxNameChars
860 ||
$name != $wgContLang->ucfirst( $name )
865 // Ensure that the name can't be misresolved as a different title,
866 // such as with extra namespace keys at the start.
867 $parsed = Title
::newFromText( $name );
868 if ( is_null( $parsed )
869 ||
$parsed->getNamespace()
870 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
874 // Check an additional blacklist of troublemaker characters.
875 // Should these be merged into the title char list?
876 $unicodeBlacklist = '/[' .
877 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
878 '\x{00a0}' . # non-breaking space
879 '\x{2000}-\x{200f}' . # various whitespace
880 '\x{2028}-\x{202f}' . # breaks and control chars
881 '\x{3000}' . # ideographic space
882 '\x{e000}-\x{f8ff}' . # private use
884 if ( preg_match( $unicodeBlacklist, $name ) ) {
892 * Usernames which fail to pass this function will be blocked
893 * from user login and new account registrations, but may be used
894 * internally by batch processes.
896 * If an account already exists in this form, login will be blocked
897 * by a failure to pass this function.
899 * @param string $name Name to match
902 public static function isUsableName( $name ) {
903 global $wgReservedUsernames;
904 // Must be a valid username, obviously ;)
905 if ( !self
::isValidUserName( $name ) ) {
909 static $reservedUsernames = false;
910 if ( !$reservedUsernames ) {
911 $reservedUsernames = $wgReservedUsernames;
912 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
915 // Certain names may be reserved for batch processes.
916 foreach ( $reservedUsernames as $reserved ) {
917 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
918 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
920 if ( $reserved == $name ) {
928 * Return the users who are members of the given group(s). In case of multiple groups,
929 * users who are members of at least one of them are returned.
931 * @param string|array $groups A single group name or an array of group names
932 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
933 * records; larger values are ignored.
934 * @param int $after ID the user to start after
935 * @return UserArrayFromResult
937 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
938 if ( $groups === [] ) {
939 return UserArrayFromResult
::newFromIDs( [] );
942 $groups = array_unique( (array)$groups );
943 $limit = min( 5000, $limit );
945 $conds = [ 'ug_group' => $groups ];
946 if ( $after !== null ) {
947 $conds[] = 'ug_user > ' . (int)$after;
950 $dbr = wfGetDB( DB_REPLICA
);
951 $ids = $dbr->selectFieldValues(
958 'ORDER BY' => 'ug_user',
962 return UserArray
::newFromIDs( $ids );
966 * Usernames which fail to pass this function will be blocked
967 * from new account registrations, but may be used internally
968 * either by batch processes or by user accounts which have
969 * already been created.
971 * Additional blacklisting may be added here rather than in
972 * isValidUserName() to avoid disrupting existing accounts.
974 * @param string $name String to match
977 public static function isCreatableName( $name ) {
978 global $wgInvalidUsernameCharacters;
980 // Ensure that the username isn't longer than 235 bytes, so that
981 // (at least for the builtin skins) user javascript and css files
982 // will work. (T25080)
983 if ( strlen( $name ) > 235 ) {
984 wfDebugLog( 'username', __METHOD__
.
985 ": '$name' invalid due to length" );
989 // Preg yells if you try to give it an empty string
990 if ( $wgInvalidUsernameCharacters !== '' ) {
991 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
992 wfDebugLog( 'username', __METHOD__
.
993 ": '$name' invalid due to wgInvalidUsernameCharacters" );
998 return self
::isUsableName( $name );
1002 * Is the input a valid password for this user?
1004 * @param string $password Desired password
1007 public function isValidPassword( $password ) {
1008 // simple boolean wrapper for getPasswordValidity
1009 return $this->getPasswordValidity( $password ) === true;
1013 * Given unvalidated password input, return error message on failure.
1015 * @param string $password Desired password
1016 * @return bool|string|array True on success, string or array of error message on failure
1018 public function getPasswordValidity( $password ) {
1019 $result = $this->checkPasswordValidity( $password );
1020 if ( $result->isGood() ) {
1024 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
1025 $messages[] = $error['message'];
1027 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
1028 $messages[] = $warning['message'];
1030 if ( count( $messages ) === 1 ) {
1031 return $messages[0];
1038 * Check if this is a valid password for this user
1040 * Create a Status object based on the password's validity.
1041 * The Status should be set to fatal if the user should not
1042 * be allowed to log in, and should have any errors that
1043 * would block changing the password.
1045 * If the return value of this is not OK, the password
1046 * should not be checked. If the return value is not Good,
1047 * the password can be checked, but the user should not be
1048 * able to set their password to this.
1050 * @param string $password Desired password
1054 public function checkPasswordValidity( $password ) {
1055 global $wgPasswordPolicy;
1057 $upp = new UserPasswordPolicy(
1058 $wgPasswordPolicy['policies'],
1059 $wgPasswordPolicy['checks']
1062 $status = Status
::newGood();
1063 $result = false; // init $result to false for the internal checks
1065 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1066 $status->error( $result );
1070 if ( $result === false ) {
1071 $status->merge( $upp->checkUserPassword( $this, $password ) );
1073 } elseif ( $result === true ) {
1076 $status->error( $result );
1077 return $status; // the isValidPassword hook set a string $result and returned true
1082 * Given unvalidated user input, return a canonical username, or false if
1083 * the username is invalid.
1084 * @param string $name User input
1085 * @param string|bool $validate Type of validation to use:
1086 * - false No validation
1087 * - 'valid' Valid for batch processes
1088 * - 'usable' Valid for batch processes and login
1089 * - 'creatable' Valid for batch processes, login and account creation
1091 * @throws InvalidArgumentException
1092 * @return bool|string
1094 public static function getCanonicalName( $name, $validate = 'valid' ) {
1095 // Force usernames to capital
1097 $name = $wgContLang->ucfirst( $name );
1099 # Reject names containing '#'; these will be cleaned up
1100 # with title normalisation, but then it's too late to
1102 if ( strpos( $name, '#' ) !== false ) {
1106 // Clean up name according to title rules,
1107 // but only when validation is requested (T14654)
1108 $t = ( $validate !== false ) ?
1109 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1110 // Check for invalid titles
1111 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1115 // Reject various classes of invalid names
1116 $name = AuthManager
::callLegacyAuthPlugin(
1117 'getCanonicalName', [ $t->getText() ], $t->getText()
1120 switch ( $validate ) {
1124 if ( !self
::isValidUserName( $name ) ) {
1129 if ( !self
::isUsableName( $name ) ) {
1134 if ( !self
::isCreatableName( $name ) ) {
1139 throw new InvalidArgumentException(
1140 'Invalid parameter value for $validate in ' . __METHOD__
);
1146 * Return a random password.
1148 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1149 * @return string New random password
1151 public static function randomPassword() {
1152 global $wgMinimalPasswordLength;
1153 return PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1157 * Set cached properties to default.
1159 * @note This no longer clears uncached lazy-initialised properties;
1160 * the constructor does that instead.
1162 * @param string|bool $name
1164 public function loadDefaults( $name = false ) {
1166 $this->mName
= $name;
1167 $this->mRealName
= '';
1169 $this->mOptionOverrides
= null;
1170 $this->mOptionsLoaded
= false;
1172 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1173 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1174 if ( $loggedOut !== 0 ) {
1175 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1177 $this->mTouched
= '1'; # Allow any pages to be cached
1180 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1181 $this->mEmailAuthenticated
= null;
1182 $this->mEmailToken
= '';
1183 $this->mEmailTokenExpires
= null;
1184 $this->mRegistration
= wfTimestamp( TS_MW
);
1185 $this->mGroupMemberships
= [];
1187 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1191 * Return whether an item has been loaded.
1193 * @param string $item Item to check. Current possibilities:
1197 * @param string $all 'all' to check if the whole object has been loaded
1198 * or any other string to check if only the item is available (e.g.
1202 public function isItemLoaded( $item, $all = 'all' ) {
1203 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1204 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1208 * Set that an item has been loaded
1210 * @param string $item
1212 protected function setItemLoaded( $item ) {
1213 if ( is_array( $this->mLoadedItems
) ) {
1214 $this->mLoadedItems
[$item] = true;
1219 * Load user data from the session.
1221 * @return bool True if the user is logged in, false otherwise.
1223 private function loadFromSession() {
1226 Hooks
::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1227 if ( $result !== null ) {
1231 // MediaWiki\Session\Session already did the necessary authentication of the user
1232 // returned here, so just use it if applicable.
1233 $session = $this->getRequest()->getSession();
1234 $user = $session->getUser();
1235 if ( $user->isLoggedIn() ) {
1236 $this->loadFromUserObject( $user );
1238 // If this user is autoblocked, set a cookie to track the Block. This has to be done on
1239 // every session load, because an autoblocked editor might not edit again from the same
1240 // IP address after being blocked.
1241 $config = RequestContext
::getMain()->getConfig();
1242 if ( $config->get( 'CookieSetOnAutoblock' ) === true ) {
1243 $block = $this->getBlock();
1244 $shouldSetCookie = $this->getRequest()->getCookie( 'BlockID' ) === null
1246 && $block->getType() === Block
::TYPE_USER
1247 && $block->isAutoblocking();
1248 if ( $shouldSetCookie ) {
1249 wfDebug( __METHOD__
. ': User is autoblocked, setting cookie to track' );
1250 $block->setCookie( $this->getRequest()->response() );
1254 // Other code expects these to be set in the session, so set them.
1255 $session->set( 'wsUserID', $this->getId() );
1256 $session->set( 'wsUserName', $this->getName() );
1257 $session->set( 'wsToken', $this->getToken() );
1264 * Load user and user_group data from the database.
1265 * $this->mId must be set, this is how the user is identified.
1267 * @param int $flags User::READ_* constant bitfield
1268 * @return bool True if the user exists, false if the user is anonymous
1270 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1272 $this->mId
= intval( $this->mId
);
1274 if ( !$this->mId
) {
1275 // Anonymous users are not in the database
1276 $this->loadDefaults();
1280 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1281 $db = wfGetDB( $index );
1283 $userQuery = self
::getQueryInfo();
1284 $s = $db->selectRow(
1285 $userQuery['tables'],
1286 $userQuery['fields'],
1287 [ 'user_id' => $this->mId
],
1293 $this->queryFlagsUsed
= $flags;
1294 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1296 if ( $s !== false ) {
1297 // Initialise user table data
1298 $this->loadFromRow( $s );
1299 $this->mGroupMemberships
= null; // deferred
1300 $this->getEditCount(); // revalidation for nulls
1305 $this->loadDefaults();
1311 * Initialize this object from a row from the user table.
1313 * @param stdClass $row Row from the user table to load.
1314 * @param array $data Further user data to load into the object
1316 * user_groups Array of arrays or stdClass result rows out of the user_groups
1317 * table. Previously you were supposed to pass an array of strings
1318 * here, but we also need expiry info nowadays, so an array of
1319 * strings is ignored.
1320 * user_properties Array with properties out of the user_properties table
1322 protected function loadFromRow( $row, $data = null ) {
1325 $this->mGroupMemberships
= null; // deferred
1327 if ( isset( $row->user_name
) ) {
1328 $this->mName
= $row->user_name
;
1329 $this->mFrom
= 'name';
1330 $this->setItemLoaded( 'name' );
1335 if ( isset( $row->user_real_name
) ) {
1336 $this->mRealName
= $row->user_real_name
;
1337 $this->setItemLoaded( 'realname' );
1342 if ( isset( $row->user_id
) ) {
1343 $this->mId
= intval( $row->user_id
);
1344 $this->mFrom
= 'id';
1345 $this->setItemLoaded( 'id' );
1350 if ( isset( $row->user_id
) && isset( $row->user_name
) ) {
1351 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1354 if ( isset( $row->user_editcount
) ) {
1355 $this->mEditCount
= $row->user_editcount
;
1360 if ( isset( $row->user_touched
) ) {
1361 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1366 if ( isset( $row->user_token
) ) {
1367 // The definition for the column is binary(32), so trim the NULs
1368 // that appends. The previous definition was char(32), so trim
1370 $this->mToken
= rtrim( $row->user_token
, " \0" );
1371 if ( $this->mToken
=== '' ) {
1372 $this->mToken
= null;
1378 if ( isset( $row->user_email
) ) {
1379 $this->mEmail
= $row->user_email
;
1380 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1381 $this->mEmailToken
= $row->user_email_token
;
1382 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1383 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1389 $this->mLoadedItems
= true;
1392 if ( is_array( $data ) ) {
1393 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1394 if ( !count( $data['user_groups'] ) ) {
1395 $this->mGroupMemberships
= [];
1397 $firstGroup = reset( $data['user_groups'] );
1398 if ( is_array( $firstGroup ) ||
is_object( $firstGroup ) ) {
1399 $this->mGroupMemberships
= [];
1400 foreach ( $data['user_groups'] as $row ) {
1401 $ugm = UserGroupMembership
::newFromRow( (object)$row );
1402 $this->mGroupMemberships
[$ugm->getGroup()] = $ugm;
1407 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1408 $this->loadOptions( $data['user_properties'] );
1414 * Load the data for this user object from another user object.
1418 protected function loadFromUserObject( $user ) {
1420 foreach ( self
::$mCacheVars as $var ) {
1421 $this->$var = $user->$var;
1426 * Load the groups from the database if they aren't already loaded.
1428 private function loadGroups() {
1429 if ( is_null( $this->mGroupMemberships
) ) {
1430 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1431 ?
wfGetDB( DB_MASTER
)
1432 : wfGetDB( DB_REPLICA
);
1433 $this->mGroupMemberships
= UserGroupMembership
::getMembershipsForUser(
1439 * Add the user to the group if he/she meets given criteria.
1441 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1442 * possible to remove manually via Special:UserRights. In such case it
1443 * will not be re-added automatically. The user will also not lose the
1444 * group if they no longer meet the criteria.
1446 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1448 * @return array Array of groups the user has been promoted to.
1450 * @see $wgAutopromoteOnce
1452 public function addAutopromoteOnceGroups( $event ) {
1453 global $wgAutopromoteOnceLogInRC;
1455 if ( wfReadOnly() ||
!$this->getId() ) {
1459 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1460 if ( !count( $toPromote ) ) {
1464 if ( !$this->checkAndSetTouched() ) {
1465 return []; // raced out (bug T48834)
1468 $oldGroups = $this->getGroups(); // previous groups
1469 $oldUGMs = $this->getGroupMemberships();
1470 foreach ( $toPromote as $group ) {
1471 $this->addGroup( $group );
1473 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1474 $newUGMs = $this->getGroupMemberships();
1476 // update groups in external authentication database
1477 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );
1478 AuthManager
::callLegacyAuthPlugin( 'updateExternalDBGroups', [ $this, $toPromote ] );
1480 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1481 $logEntry->setPerformer( $this );
1482 $logEntry->setTarget( $this->getUserPage() );
1483 $logEntry->setParameters( [
1484 '4::oldgroups' => $oldGroups,
1485 '5::newgroups' => $newGroups,
1487 $logid = $logEntry->insert();
1488 if ( $wgAutopromoteOnceLogInRC ) {
1489 $logEntry->publish( $logid );
1496 * Builds update conditions. Additional conditions may be added to $conditions to
1497 * protected against race conditions using a compare-and-set (CAS) mechanism
1498 * based on comparing $this->mTouched with the user_touched field.
1500 * @param Database $db
1501 * @param array $conditions WHERE conditions for use with Database::update
1502 * @return array WHERE conditions for use with Database::update
1504 protected function makeUpdateConditions( Database
$db, array $conditions ) {
1505 if ( $this->mTouched
) {
1506 // CAS check: only update if the row wasn't changed sicne it was loaded.
1507 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1514 * Bump user_touched if it didn't change since this object was loaded
1516 * On success, the mTouched field is updated.
1517 * The user serialization cache is always cleared.
1519 * @return bool Whether user_touched was actually updated
1522 protected function checkAndSetTouched() {
1525 if ( !$this->mId
) {
1526 return false; // anon
1529 // Get a new user_touched that is higher than the old one
1530 $newTouched = $this->newTouchedTimestamp();
1532 $dbw = wfGetDB( DB_MASTER
);
1533 $dbw->update( 'user',
1534 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1535 $this->makeUpdateConditions( $dbw, [
1536 'user_id' => $this->mId
,
1540 $success = ( $dbw->affectedRows() > 0 );
1543 $this->mTouched
= $newTouched;
1544 $this->clearSharedCache();
1546 // Clears on failure too since that is desired if the cache is stale
1547 $this->clearSharedCache( 'refresh' );
1554 * Clear various cached data stored in this object. The cache of the user table
1555 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1557 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1558 * given source. May be "name", "id", "defaults", "session", or false for no reload.
1560 public function clearInstanceCache( $reloadFrom = false ) {
1561 $this->mNewtalk
= -1;
1562 $this->mDatePreference
= null;
1563 $this->mBlockedby
= -1; # Unset
1564 $this->mHash
= false;
1565 $this->mRights
= null;
1566 $this->mEffectiveGroups
= null;
1567 $this->mImplicitGroups
= null;
1568 $this->mGroupMemberships
= null;
1569 $this->mOptions
= null;
1570 $this->mOptionsLoaded
= false;
1571 $this->mEditCount
= null;
1573 if ( $reloadFrom ) {
1574 $this->mLoadedItems
= [];
1575 $this->mFrom
= $reloadFrom;
1580 * Combine the language default options with any site-specific options
1581 * and add the default language variants.
1583 * @return array Array of String options
1585 public static function getDefaultOptions() {
1586 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1588 static $defOpt = null;
1589 static $defOptLang = null;
1591 if ( $defOpt !== null && $defOptLang === $wgContLang->getCode() ) {
1592 // $wgContLang does not change (and should not change) mid-request,
1593 // but the unit tests change it anyway, and expect this method to
1594 // return values relevant to the current $wgContLang.
1598 $defOpt = $wgDefaultUserOptions;
1599 // Default language setting
1600 $defOptLang = $wgContLang->getCode();
1601 $defOpt['language'] = $defOptLang;
1602 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1603 $defOpt[$langCode == $wgContLang->getCode() ?
'variant' : "variant-$langCode"] = $langCode;
1606 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1607 // since extensions may change the set of searchable namespaces depending
1608 // on user groups/permissions.
1609 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1610 $defOpt['searchNs' . $nsnum] = (bool)$val;
1612 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1614 Hooks
::run( 'UserGetDefaultOptions', [ &$defOpt ] );
1620 * Get a given default option value.
1622 * @param string $opt Name of option to retrieve
1623 * @return string Default option value
1625 public static function getDefaultOption( $opt ) {
1626 $defOpts = self
::getDefaultOptions();
1627 if ( isset( $defOpts[$opt] ) ) {
1628 return $defOpts[$opt];
1635 * Get blocking information
1636 * @param bool $bFromSlave Whether to check the replica DB first.
1637 * To improve performance, non-critical checks are done against replica DBs.
1638 * Check when actually saving should be done against master.
1640 private function getBlockedStatus( $bFromSlave = true ) {
1641 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff, $wgSoftBlockRanges;
1643 if ( -1 != $this->mBlockedby
) {
1647 wfDebug( __METHOD__
. ": checking...\n" );
1649 // Initialize data...
1650 // Otherwise something ends up stomping on $this->mBlockedby when
1651 // things get lazy-loaded later, causing false positive block hits
1652 // due to -1 !== 0. Probably session-related... Nothing should be
1653 // overwriting mBlockedby, surely?
1656 # We only need to worry about passing the IP address to the Block generator if the
1657 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1658 # know which IP address they're actually coming from
1660 if ( !$this->isAllowed( 'ipblock-exempt' ) ) {
1661 // $wgUser->getName() only works after the end of Setup.php. Until
1662 // then, assume it's a logged-out user.
1663 $globalUserName = $wgUser->isSafeToLoad()
1664 ?
$wgUser->getName()
1665 : IP
::sanitizeIP( $wgUser->getRequest()->getIP() );
1666 if ( $this->getName() === $globalUserName ) {
1667 $ip = $this->getRequest()->getIP();
1672 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1675 if ( !$block instanceof Block
) {
1676 $block = $this->getBlockFromCookieValue( $this->getRequest()->getCookie( 'BlockID' ) );
1680 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1682 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1683 $block = new Block( [
1684 'byText' => wfMessage( 'proxyblocker' )->text(),
1685 'reason' => wfMessage( 'proxyblockreason' )->text(),
1687 'systemBlock' => 'proxy',
1689 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1690 $block = new Block( [
1691 'byText' => wfMessage( 'sorbs' )->text(),
1692 'reason' => wfMessage( 'sorbsreason' )->text(),
1694 'systemBlock' => 'dnsbl',
1699 // (T25343) Apply IP blocks to the contents of XFF headers, if enabled
1700 if ( !$block instanceof Block
1701 && $wgApplyIpBlocksToXff
1703 && !in_array( $ip, $wgProxyWhitelist )
1705 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1706 $xff = array_map( 'trim', explode( ',', $xff ) );
1707 $xff = array_diff( $xff, [ $ip ] );
1708 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1709 $block = Block
::chooseBlock( $xffblocks, $xff );
1710 if ( $block instanceof Block
) {
1711 # Mangle the reason to alert the user that the block
1712 # originated from matching the X-Forwarded-For header.
1713 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->text();
1717 if ( !$block instanceof Block
1720 && IP
::isInRanges( $ip, $wgSoftBlockRanges )
1722 $block = new Block( [
1724 'byText' => 'MediaWiki default',
1725 'reason' => wfMessage( 'softblockrangesreason', $ip )->text(),
1727 'systemBlock' => 'wgSoftBlockRanges',
1731 if ( $block instanceof Block
) {
1732 wfDebug( __METHOD__
. ": Found block.\n" );
1733 $this->mBlock
= $block;
1734 $this->mBlockedby
= $block->getByName();
1735 $this->mBlockreason
= $block->mReason
;
1736 $this->mHideName
= $block->mHideName
;
1737 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1739 $this->mBlockedby
= '';
1740 $this->mHideName
= 0;
1741 $this->mAllowUsertalk
= false;
1744 // Avoid PHP 7.1 warning of passing $this by reference
1747 Hooks
::run( 'GetBlockedStatus', [ &$user ] );
1751 * Try to load a Block from an ID given in a cookie value.
1752 * @param string|null $blockCookieVal The cookie value to check.
1753 * @return Block|bool The Block object, or false if none could be loaded.
1755 protected function getBlockFromCookieValue( $blockCookieVal ) {
1756 // Make sure there's something to check. The cookie value must start with a number.
1757 if ( strlen( $blockCookieVal ) < 1 ||
!is_numeric( substr( $blockCookieVal, 0, 1 ) ) ) {
1760 // Load the Block from the ID in the cookie.
1761 $blockCookieId = Block
::getIdFromCookieValue( $blockCookieVal );
1762 if ( $blockCookieId !== null ) {
1763 // An ID was found in the cookie.
1764 $tmpBlock = Block
::newFromID( $blockCookieId );
1765 if ( $tmpBlock instanceof Block
) {
1766 // Check the validity of the block.
1767 $blockIsValid = $tmpBlock->getType() == Block
::TYPE_USER
1768 && !$tmpBlock->isExpired()
1769 && $tmpBlock->isAutoblocking();
1770 $config = RequestContext
::getMain()->getConfig();
1771 $useBlockCookie = ( $config->get( 'CookieSetOnAutoblock' ) === true );
1772 if ( $blockIsValid && $useBlockCookie ) {
1776 // If the block is not valid, remove the cookie.
1777 Block
::clearCookie( $this->getRequest()->response() );
1780 // If the block doesn't exist, remove the cookie.
1781 Block
::clearCookie( $this->getRequest()->response() );
1788 * Whether the given IP is in a DNS blacklist.
1790 * @param string $ip IP to check
1791 * @param bool $checkWhitelist Whether to check the whitelist first
1792 * @return bool True if blacklisted.
1794 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1795 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1797 if ( !$wgEnableDnsBlacklist ) {
1801 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1805 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
1809 * Whether the given IP is in a given DNS blacklist.
1811 * @param string $ip IP to check
1812 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1813 * @return bool True if blacklisted.
1815 public function inDnsBlacklist( $ip, $bases ) {
1817 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
1818 if ( IP
::isIPv4( $ip ) ) {
1819 // Reverse IP, T23255
1820 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1822 foreach ( (array)$bases as $base ) {
1824 // If we have an access key, use that too (ProjectHoneypot, etc.)
1826 if ( is_array( $base ) ) {
1827 if ( count( $base ) >= 2 ) {
1828 // Access key is 1, base URL is 0
1829 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1831 $host = "$ipReversed.{$base[0]}";
1833 $basename = $base[0];
1835 $host = "$ipReversed.$base";
1839 $ipList = gethostbynamel( $host );
1842 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
1846 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
1855 * Check if an IP address is in the local proxy list
1861 public static function isLocallyBlockedProxy( $ip ) {
1862 global $wgProxyList;
1864 if ( !$wgProxyList ) {
1868 if ( !is_array( $wgProxyList ) ) {
1869 // Load values from the specified file
1870 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1873 $resultProxyList = [];
1874 $deprecatedIPEntries = [];
1876 // backward compatibility: move all ip addresses in keys to values
1877 foreach ( $wgProxyList as $key => $value ) {
1878 $keyIsIP = IP
::isIPAddress( $key );
1879 $valueIsIP = IP
::isIPAddress( $value );
1880 if ( $keyIsIP && !$valueIsIP ) {
1881 $deprecatedIPEntries[] = $key;
1882 $resultProxyList[] = $key;
1883 } elseif ( $keyIsIP && $valueIsIP ) {
1884 $deprecatedIPEntries[] = $key;
1885 $resultProxyList[] = $key;
1886 $resultProxyList[] = $value;
1888 $resultProxyList[] = $value;
1892 if ( $deprecatedIPEntries ) {
1894 'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
1895 implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
1898 $proxyListIPSet = new IPSet( $resultProxyList );
1899 return $proxyListIPSet->match( $ip );
1903 * Is this user subject to rate limiting?
1905 * @return bool True if rate limited
1907 public function isPingLimitable() {
1908 global $wgRateLimitsExcludedIPs;
1909 if ( IP
::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1910 // No other good way currently to disable rate limits
1911 // for specific IPs. :P
1912 // But this is a crappy hack and should die.
1915 return !$this->isAllowed( 'noratelimit' );
1919 * Primitive rate limits: enforce maximum actions per time period
1920 * to put a brake on flooding.
1922 * The method generates both a generic profiling point and a per action one
1923 * (suffix being "-$action".
1925 * @note When using a shared cache like memcached, IP-address
1926 * last-hit counters will be shared across wikis.
1928 * @param string $action Action to enforce; 'edit' if unspecified
1929 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1930 * @return bool True if a rate limiter was tripped
1932 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1933 // Avoid PHP 7.1 warning of passing $this by reference
1935 // Call the 'PingLimiter' hook
1937 if ( !Hooks
::run( 'PingLimiter', [ &$user, $action, &$result, $incrBy ] ) ) {
1941 global $wgRateLimits;
1942 if ( !isset( $wgRateLimits[$action] ) ) {
1946 $limits = array_merge(
1947 [ '&can-bypass' => true ],
1948 $wgRateLimits[$action]
1951 // Some groups shouldn't trigger the ping limiter, ever
1952 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
1957 $id = $this->getId();
1959 $isNewbie = $this->isNewbie();
1960 $cache = ObjectCache
::getLocalClusterInstance();
1964 if ( isset( $limits['anon'] ) ) {
1965 $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1968 // limits for logged-in users
1969 if ( isset( $limits['user'] ) ) {
1970 $userLimit = $limits['user'];
1972 // limits for newbie logged-in users
1973 if ( $isNewbie && isset( $limits['newbie'] ) ) {
1974 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1978 // limits for anons and for newbie logged-in users
1981 if ( isset( $limits['ip'] ) ) {
1982 $ip = $this->getRequest()->getIP();
1983 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1985 // subnet-based limits
1986 if ( isset( $limits['subnet'] ) ) {
1987 $ip = $this->getRequest()->getIP();
1988 $subnet = IP
::getSubnet( $ip );
1989 if ( $subnet !== false ) {
1990 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1995 // Check for group-specific permissions
1996 // If more than one group applies, use the group with the highest limit ratio (max/period)
1997 foreach ( $this->getGroups() as $group ) {
1998 if ( isset( $limits[$group] ) ) {
1999 if ( $userLimit === false
2000 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
2002 $userLimit = $limits[$group];
2007 // Set the user limit key
2008 if ( $userLimit !== false ) {
2009 list( $max, $period ) = $userLimit;
2010 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
2011 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
2014 // ip-based limits for all ping-limitable users
2015 if ( isset( $limits['ip-all'] ) ) {
2016 $ip = $this->getRequest()->getIP();
2017 // ignore if user limit is more permissive
2018 if ( $isNewbie ||
$userLimit === false
2019 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
2020 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
2024 // subnet-based limits for all ping-limitable users
2025 if ( isset( $limits['subnet-all'] ) ) {
2026 $ip = $this->getRequest()->getIP();
2027 $subnet = IP
::getSubnet( $ip );
2028 if ( $subnet !== false ) {
2029 // ignore if user limit is more permissive
2030 if ( $isNewbie ||
$userLimit === false
2031 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
2032 > $userLimit[0] / $userLimit[1] ) {
2033 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
2039 foreach ( $keys as $key => $limit ) {
2040 list( $max, $period ) = $limit;
2041 $summary = "(limit $max in {$period}s)";
2042 $count = $cache->get( $key );
2045 if ( $count >= $max ) {
2046 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
2047 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
2050 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
2053 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
2054 if ( $incrBy > 0 ) {
2055 $cache->add( $key, 0, intval( $period ) ); // first ping
2058 if ( $incrBy > 0 ) {
2059 $cache->incr( $key, $incrBy );
2067 * Check if user is blocked
2069 * @param bool $bFromSlave Whether to check the replica DB instead of
2070 * the master. Hacked from false due to horrible probs on site.
2071 * @return bool True if blocked, false otherwise
2073 public function isBlocked( $bFromSlave = true ) {
2074 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
2078 * Get the block affecting the user, or null if the user is not blocked
2080 * @param bool $bFromSlave Whether to check the replica DB instead of the master
2081 * @return Block|null
2083 public function getBlock( $bFromSlave = true ) {
2084 $this->getBlockedStatus( $bFromSlave );
2085 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
2089 * Check if user is blocked from editing a particular article
2091 * @param Title $title Title to check
2092 * @param bool $bFromSlave Whether to check the replica DB instead of the master
2095 public function isBlockedFrom( $title, $bFromSlave = false ) {
2096 global $wgBlockAllowsUTEdit;
2098 $blocked = $this->isBlocked( $bFromSlave );
2099 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
2100 // If a user's name is suppressed, they cannot make edits anywhere
2101 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName()
2102 && $title->getNamespace() == NS_USER_TALK
) {
2104 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
2107 Hooks
::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
2113 * If user is blocked, return the name of the user who placed the block
2114 * @return string Name of blocker
2116 public function blockedBy() {
2117 $this->getBlockedStatus();
2118 return $this->mBlockedby
;
2122 * If user is blocked, return the specified reason for the block
2123 * @return string Blocking reason
2125 public function blockedFor() {
2126 $this->getBlockedStatus();
2127 return $this->mBlockreason
;
2131 * If user is blocked, return the ID for the block
2132 * @return int Block ID
2134 public function getBlockId() {
2135 $this->getBlockedStatus();
2136 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2140 * Check if user is blocked on all wikis.
2141 * Do not use for actual edit permission checks!
2142 * This is intended for quick UI checks.
2144 * @param string $ip IP address, uses current client if none given
2145 * @return bool True if blocked, false otherwise
2147 public function isBlockedGlobally( $ip = '' ) {
2148 return $this->getGlobalBlock( $ip ) instanceof Block
;
2152 * Check if user is blocked on all wikis.
2153 * Do not use for actual edit permission checks!
2154 * This is intended for quick UI checks.
2156 * @param string $ip IP address, uses current client if none given
2157 * @return Block|null Block object if blocked, null otherwise
2158 * @throws FatalError
2159 * @throws MWException
2161 public function getGlobalBlock( $ip = '' ) {
2162 if ( $this->mGlobalBlock
!== null ) {
2163 return $this->mGlobalBlock ?
: null;
2165 // User is already an IP?
2166 if ( IP
::isIPAddress( $this->getName() ) ) {
2167 $ip = $this->getName();
2169 $ip = $this->getRequest()->getIP();
2171 // Avoid PHP 7.1 warning of passing $this by reference
2175 Hooks
::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
2177 if ( $blocked && $block === null ) {
2178 // back-compat: UserIsBlockedGlobally didn't have $block param first
2179 $block = new Block( [
2181 'systemBlock' => 'global-block'
2185 $this->mGlobalBlock
= $blocked ?
$block : false;
2186 return $this->mGlobalBlock ?
: null;
2190 * Check if user account is locked
2192 * @return bool True if locked, false otherwise
2194 public function isLocked() {
2195 if ( $this->mLocked
!== null ) {
2196 return $this->mLocked
;
2198 // Avoid PHP 7.1 warning of passing $this by reference
2200 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$user ], null );
2201 $this->mLocked
= $authUser && $authUser->isLocked();
2202 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2203 return $this->mLocked
;
2207 * Check if user account is hidden
2209 * @return bool True if hidden, false otherwise
2211 public function isHidden() {
2212 if ( $this->mHideName
!== null ) {
2213 return $this->mHideName
;
2215 $this->getBlockedStatus();
2216 if ( !$this->mHideName
) {
2217 // Avoid PHP 7.1 warning of passing $this by reference
2219 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$user ], null );
2220 $this->mHideName
= $authUser && $authUser->isHidden();
2221 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2223 return $this->mHideName
;
2227 * Get the user's ID.
2228 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2230 public function getId() {
2231 if ( $this->mId
=== null && $this->mName
!== null && self
::isIP( $this->mName
) ) {
2232 // Special case, we know the user is anonymous
2234 } elseif ( !$this->isItemLoaded( 'id' ) ) {
2235 // Don't load if this was initialized from an ID
2239 return (int)$this->mId
;
2243 * Set the user and reload all fields according to a given ID
2244 * @param int $v User ID to reload
2246 public function setId( $v ) {
2248 $this->clearInstanceCache( 'id' );
2252 * Get the user name, or the IP of an anonymous user
2253 * @return string User's name or IP address
2255 public function getName() {
2256 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2257 // Special case optimisation
2258 return $this->mName
;
2261 if ( $this->mName
=== false ) {
2263 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2265 return $this->mName
;
2270 * Set the user name.
2272 * This does not reload fields from the database according to the given
2273 * name. Rather, it is used to create a temporary "nonexistent user" for
2274 * later addition to the database. It can also be used to set the IP
2275 * address for an anonymous user to something other than the current
2278 * @note User::newFromName() has roughly the same function, when the named user
2280 * @param string $str New user name to set
2282 public function setName( $str ) {
2284 $this->mName
= $str;
2288 * Get the user's name escaped by underscores.
2289 * @return string Username escaped by underscores.
2291 public function getTitleKey() {
2292 return str_replace( ' ', '_', $this->getName() );
2296 * Check if the user has new messages.
2297 * @return bool True if the user has new messages
2299 public function getNewtalk() {
2302 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2303 if ( $this->mNewtalk
=== -1 ) {
2304 $this->mNewtalk
= false; # reset talk page status
2306 // Check memcached separately for anons, who have no
2307 // entire User object stored in there.
2308 if ( !$this->mId
) {
2309 global $wgDisableAnonTalk;
2310 if ( $wgDisableAnonTalk ) {
2311 // Anon newtalk disabled by configuration.
2312 $this->mNewtalk
= false;
2314 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2317 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2321 return (bool)$this->mNewtalk
;
2325 * Return the data needed to construct links for new talk page message
2326 * alerts. If there are new messages, this will return an associative array
2327 * with the following data:
2328 * wiki: The database name of the wiki
2329 * link: Root-relative link to the user's talk page
2330 * rev: The last talk page revision that the user has seen or null. This
2331 * is useful for building diff links.
2332 * If there are no new messages, it returns an empty array.
2333 * @note This function was designed to accomodate multiple talk pages, but
2334 * currently only returns a single link and revision.
2337 public function getNewMessageLinks() {
2338 // Avoid PHP 7.1 warning of passing $this by reference
2341 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
2343 } elseif ( !$this->getNewtalk() ) {
2346 $utp = $this->getTalkPage();
2347 $dbr = wfGetDB( DB_REPLICA
);
2348 // Get the "last viewed rev" timestamp from the oldest message notification
2349 $timestamp = $dbr->selectField( 'user_newtalk',
2350 'MIN(user_last_timestamp)',
2351 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2353 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2354 return [ [ 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ] ];
2358 * Get the revision ID for the last talk page revision viewed by the talk
2360 * @return int|null Revision ID or null
2362 public function getNewMessageRevisionId() {
2363 $newMessageRevisionId = null;
2364 $newMessageLinks = $this->getNewMessageLinks();
2365 if ( $newMessageLinks ) {
2366 // Note: getNewMessageLinks() never returns more than a single link
2367 // and it is always for the same wiki, but we double-check here in
2368 // case that changes some time in the future.
2369 if ( count( $newMessageLinks ) === 1
2370 && $newMessageLinks[0]['wiki'] === wfWikiID()
2371 && $newMessageLinks[0]['rev']
2373 /** @var Revision $newMessageRevision */
2374 $newMessageRevision = $newMessageLinks[0]['rev'];
2375 $newMessageRevisionId = $newMessageRevision->getId();
2378 return $newMessageRevisionId;
2382 * Internal uncached check for new messages
2385 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2386 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2387 * @return bool True if the user has new messages
2389 protected function checkNewtalk( $field, $id ) {
2390 $dbr = wfGetDB( DB_REPLICA
);
2392 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2394 return $ok !== false;
2398 * Add or update the new messages flag
2399 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2400 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2401 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2402 * @return bool True if successful, false otherwise
2404 protected function updateNewtalk( $field, $id, $curRev = null ) {
2405 // Get timestamp of the talk page revision prior to the current one
2406 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2407 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2408 // Mark the user as having new messages since this revision
2409 $dbw = wfGetDB( DB_MASTER
);
2410 $dbw->insert( 'user_newtalk',
2411 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2414 if ( $dbw->affectedRows() ) {
2415 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2418 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2424 * Clear the new messages flag for the given user
2425 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2426 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2427 * @return bool True if successful, false otherwise
2429 protected function deleteNewtalk( $field, $id ) {
2430 $dbw = wfGetDB( DB_MASTER
);
2431 $dbw->delete( 'user_newtalk',
2434 if ( $dbw->affectedRows() ) {
2435 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2438 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2444 * Update the 'You have new messages!' status.
2445 * @param bool $val Whether the user has new messages
2446 * @param Revision $curRev New, as yet unseen revision of the user talk
2447 * page. Ignored if null or !$val.
2449 public function setNewtalk( $val, $curRev = null ) {
2450 if ( wfReadOnly() ) {
2455 $this->mNewtalk
= $val;
2457 if ( $this->isAnon() ) {
2459 $id = $this->getName();
2462 $id = $this->getId();
2466 $changed = $this->updateNewtalk( $field, $id, $curRev );
2468 $changed = $this->deleteNewtalk( $field, $id );
2472 $this->invalidateCache();
2477 * Generate a current or new-future timestamp to be stored in the
2478 * user_touched field when we update things.
2479 * @return string Timestamp in TS_MW format
2481 private function newTouchedTimestamp() {
2482 global $wgClockSkewFudge;
2484 $time = wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2485 if ( $this->mTouched
&& $time <= $this->mTouched
) {
2486 $time = wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2493 * Clear user data from memcached
2495 * Use after applying updates to the database; caller's
2496 * responsibility to update user_touched if appropriate.
2498 * Called implicitly from invalidateCache() and saveSettings().
2500 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2502 public function clearSharedCache( $mode = 'changed' ) {
2503 if ( !$this->getId() ) {
2507 $cache = ObjectCache
::getMainWANInstance();
2508 $key = $this->getCacheKey( $cache );
2509 if ( $mode === 'refresh' ) {
2510 $cache->delete( $key, 1 );
2512 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2513 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2514 $lb->getConnection( DB_MASTER
)->onTransactionPreCommitOrIdle(
2515 function () use ( $cache, $key ) {
2516 $cache->delete( $key );
2521 $cache->delete( $key );
2527 * Immediately touch the user data cache for this account
2529 * Calls touch() and removes account data from memcached
2531 public function invalidateCache() {
2533 $this->clearSharedCache();
2537 * Update the "touched" timestamp for the user
2539 * This is useful on various login/logout events when making sure that
2540 * a browser or proxy that has multiple tenants does not suffer cache
2541 * pollution where the new user sees the old users content. The value
2542 * of getTouched() is checked when determining 304 vs 200 responses.
2543 * Unlike invalidateCache(), this preserves the User object cache and
2544 * avoids database writes.
2548 public function touch() {
2549 $id = $this->getId();
2551 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2552 $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
2553 $cache->touchCheckKey( $key );
2554 $this->mQuickTouched
= null;
2559 * Validate the cache for this account.
2560 * @param string $timestamp A timestamp in TS_MW format
2563 public function validateCache( $timestamp ) {
2564 return ( $timestamp >= $this->getTouched() );
2568 * Get the user touched timestamp
2570 * Use this value only to validate caches via inequalities
2571 * such as in the case of HTTP If-Modified-Since response logic
2573 * @return string TS_MW Timestamp
2575 public function getTouched() {
2579 if ( $this->mQuickTouched
=== null ) {
2580 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2581 $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId
);
2583 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2586 return max( $this->mTouched
, $this->mQuickTouched
);
2589 return $this->mTouched
;
2593 * Get the user_touched timestamp field (time of last DB updates)
2594 * @return string TS_MW Timestamp
2597 public function getDBTouched() {
2600 return $this->mTouched
;
2604 * Set the password and reset the random token.
2605 * Calls through to authentication plugin if necessary;
2606 * will have no effect if the auth plugin refuses to
2607 * pass the change through or if the legal password
2610 * As a special case, setting the password to null
2611 * wipes it, so the account cannot be logged in until
2612 * a new password is set, for instance via e-mail.
2614 * @deprecated since 1.27, use AuthManager instead
2615 * @param string $str New password to set
2616 * @throws PasswordError On failure
2619 public function setPassword( $str ) {
2620 return $this->setPasswordInternal( $str );
2624 * Set the password and reset the random token unconditionally.
2626 * @deprecated since 1.27, use AuthManager instead
2627 * @param string|null $str New password to set or null to set an invalid
2628 * password hash meaning that the user will not be able to log in
2629 * through the web interface.
2631 public function setInternalPassword( $str ) {
2632 $this->setPasswordInternal( $str );
2636 * Actually set the password and such
2637 * @since 1.27 cannot set a password for a user not in the database
2638 * @param string|null $str New password to set or null to set an invalid
2639 * password hash meaning that the user will not be able to log in
2640 * through the web interface.
2641 * @return bool Success
2643 private function setPasswordInternal( $str ) {
2644 $manager = AuthManager
::singleton();
2646 // If the user doesn't exist yet, fail
2647 if ( !$manager->userExists( $this->getName() ) ) {
2648 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2651 $status = $this->changeAuthenticationData( [
2652 'username' => $this->getName(),
2656 if ( !$status->isGood() ) {
2657 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2658 ->info( __METHOD__
. ': Password change rejected: '
2659 . $status->getWikiText( null, null, 'en' ) );
2663 $this->setOption( 'watchlisttoken', false );
2664 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2670 * Changes credentials of the user.
2672 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2673 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2674 * e.g. when no provider handled the change.
2676 * @param array $data A set of authentication data in fieldname => value format. This is the
2677 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2681 public function changeAuthenticationData( array $data ) {
2682 $manager = AuthManager
::singleton();
2683 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2684 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2686 $status = Status
::newGood( 'ignored' );
2687 foreach ( $reqs as $req ) {
2688 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2690 if ( $status->getValue() === 'ignored' ) {
2691 $status->warning( 'authenticationdatachange-ignored' );
2694 if ( $status->isGood() ) {
2695 foreach ( $reqs as $req ) {
2696 $manager->changeAuthenticationData( $req );
2703 * Get the user's current token.
2704 * @param bool $forceCreation Force the generation of a new token if the
2705 * user doesn't have one (default=true for backwards compatibility).
2706 * @return string|null Token
2708 public function getToken( $forceCreation = true ) {
2709 global $wgAuthenticationTokenVersion;
2712 if ( !$this->mToken
&& $forceCreation ) {
2716 if ( !$this->mToken
) {
2717 // The user doesn't have a token, return null to indicate that.
2719 } elseif ( $this->mToken
=== self
::INVALID_TOKEN
) {
2720 // We return a random value here so existing token checks are very
2722 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2723 } elseif ( $wgAuthenticationTokenVersion === null ) {
2724 // $wgAuthenticationTokenVersion not in use, so return the raw secret
2725 return $this->mToken
;
2727 // $wgAuthenticationTokenVersion in use, so hmac it.
2728 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
2730 // The raw hash can be overly long. Shorten it up.
2731 $len = max( 32, self
::TOKEN_LENGTH
);
2732 if ( strlen( $ret ) < $len ) {
2733 // Should never happen, even md5 is 128 bits
2734 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
2736 return substr( $ret, -$len );
2741 * Set the random token (used for persistent authentication)
2742 * Called from loadDefaults() among other places.
2744 * @param string|bool $token If specified, set the token to this value
2746 public function setToken( $token = false ) {
2748 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
2749 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
2750 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
2751 } elseif ( !$token ) {
2752 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2754 $this->mToken
= $token;
2759 * Set the password for a password reminder or new account email
2761 * @deprecated Removed in 1.27. Use PasswordReset instead.
2762 * @param string $str New password to set or null to set an invalid
2763 * password hash meaning that the user will not be able to use it
2764 * @param bool $throttle If true, reset the throttle timestamp to the present
2766 public function setNewpassword( $str, $throttle = true ) {
2767 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2771 * Get the user's e-mail address
2772 * @return string User's email address
2774 public function getEmail() {
2776 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
2777 return $this->mEmail
;
2781 * Get the timestamp of the user's e-mail authentication
2782 * @return string TS_MW timestamp
2784 public function getEmailAuthenticationTimestamp() {
2786 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
2787 return $this->mEmailAuthenticated
;
2791 * Set the user's e-mail address
2792 * @param string $str New e-mail address
2794 public function setEmail( $str ) {
2796 if ( $str == $this->mEmail
) {
2799 $this->invalidateEmail();
2800 $this->mEmail
= $str;
2801 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
2805 * Set the user's e-mail address and a confirmation mail if needed.
2808 * @param string $str New e-mail address
2811 public function setEmailWithConfirmation( $str ) {
2812 global $wgEnableEmail, $wgEmailAuthentication;
2814 if ( !$wgEnableEmail ) {
2815 return Status
::newFatal( 'emaildisabled' );
2818 $oldaddr = $this->getEmail();
2819 if ( $str === $oldaddr ) {
2820 return Status
::newGood( true );
2823 $type = $oldaddr != '' ?
'changed' : 'set';
2824 $notificationResult = null;
2826 if ( $wgEmailAuthentication ) {
2827 // Send the user an email notifying the user of the change in registered
2828 // email address on their previous email address
2829 if ( $type == 'changed' ) {
2830 $change = $str != '' ?
'changed' : 'removed';
2831 $notificationResult = $this->sendMail(
2832 wfMessage( 'notificationemail_subject_' . $change )->text(),
2833 wfMessage( 'notificationemail_body_' . $change,
2834 $this->getRequest()->getIP(),
2841 $this->setEmail( $str );
2843 if ( $str !== '' && $wgEmailAuthentication ) {
2844 // Send a confirmation request to the new address if needed
2845 $result = $this->sendConfirmationMail( $type );
2847 if ( $notificationResult !== null ) {
2848 $result->merge( $notificationResult );
2851 if ( $result->isGood() ) {
2852 // Say to the caller that a confirmation and notification mail has been sent
2853 $result->value
= 'eauth';
2856 $result = Status
::newGood( true );
2863 * Get the user's real name
2864 * @return string User's real name
2866 public function getRealName() {
2867 if ( !$this->isItemLoaded( 'realname' ) ) {
2871 return $this->mRealName
;
2875 * Set the user's real name
2876 * @param string $str New real name
2878 public function setRealName( $str ) {
2880 $this->mRealName
= $str;
2884 * Get the user's current setting for a given option.
2886 * @param string $oname The option to check
2887 * @param string $defaultOverride A default value returned if the option does not exist
2888 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2889 * @return string|null User's current value for the option
2890 * @see getBoolOption()
2891 * @see getIntOption()
2893 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2894 global $wgHiddenPrefs;
2895 $this->loadOptions();
2897 # We want 'disabled' preferences to always behave as the default value for
2898 # users, even if they have set the option explicitly in their settings (ie they
2899 # set it, and then it was disabled removing their ability to change it). But
2900 # we don't want to erase the preferences in the database in case the preference
2901 # is re-enabled again. So don't touch $mOptions, just override the returned value
2902 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2903 return self
::getDefaultOption( $oname );
2906 if ( array_key_exists( $oname, $this->mOptions
) ) {
2907 return $this->mOptions
[$oname];
2909 return $defaultOverride;
2914 * Get all user's options
2916 * @param int $flags Bitwise combination of:
2917 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
2918 * to the default value. (Since 1.25)
2921 public function getOptions( $flags = 0 ) {
2922 global $wgHiddenPrefs;
2923 $this->loadOptions();
2924 $options = $this->mOptions
;
2926 # We want 'disabled' preferences to always behave as the default value for
2927 # users, even if they have set the option explicitly in their settings (ie they
2928 # set it, and then it was disabled removing their ability to change it). But
2929 # we don't want to erase the preferences in the database in case the preference
2930 # is re-enabled again. So don't touch $mOptions, just override the returned value
2931 foreach ( $wgHiddenPrefs as $pref ) {
2932 $default = self
::getDefaultOption( $pref );
2933 if ( $default !== null ) {
2934 $options[$pref] = $default;
2938 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
2939 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
2946 * Get the user's current setting for a given option, as a boolean value.
2948 * @param string $oname The option to check
2949 * @return bool User's current value for the option
2952 public function getBoolOption( $oname ) {
2953 return (bool)$this->getOption( $oname );
2957 * Get the user's current setting for a given option, as an integer value.
2959 * @param string $oname The option to check
2960 * @param int $defaultOverride A default value returned if the option does not exist
2961 * @return int User's current value for the option
2964 public function getIntOption( $oname, $defaultOverride = 0 ) {
2965 $val = $this->getOption( $oname );
2967 $val = $defaultOverride;
2969 return intval( $val );
2973 * Set the given option for a user.
2975 * You need to call saveSettings() to actually write to the database.
2977 * @param string $oname The option to set
2978 * @param mixed $val New value to set
2980 public function setOption( $oname, $val ) {
2981 $this->loadOptions();
2983 // Explicitly NULL values should refer to defaults
2984 if ( is_null( $val ) ) {
2985 $val = self
::getDefaultOption( $oname );
2988 $this->mOptions
[$oname] = $val;
2992 * Get a token stored in the preferences (like the watchlist one),
2993 * resetting it if it's empty (and saving changes).
2995 * @param string $oname The option name to retrieve the token from
2996 * @return string|bool User's current value for the option, or false if this option is disabled.
2997 * @see resetTokenFromOption()
2999 * @deprecated since 1.26 Applications should use the OAuth extension
3001 public function getTokenFromOption( $oname ) {
3002 global $wgHiddenPrefs;
3004 $id = $this->getId();
3005 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
3009 $token = $this->getOption( $oname );
3011 // Default to a value based on the user token to avoid space
3012 // wasted on storing tokens for all users. When this option
3013 // is set manually by the user, only then is it stored.
3014 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
3021 * Reset a token stored in the preferences (like the watchlist one).
3022 * *Does not* save user's preferences (similarly to setOption()).
3024 * @param string $oname The option name to reset the token in
3025 * @return string|bool New token value, or false if this option is disabled.
3026 * @see getTokenFromOption()
3029 public function resetTokenFromOption( $oname ) {
3030 global $wgHiddenPrefs;
3031 if ( in_array( $oname, $wgHiddenPrefs ) ) {
3035 $token = MWCryptRand
::generateHex( 40 );
3036 $this->setOption( $oname, $token );
3041 * Return a list of the types of user options currently returned by
3042 * User::getOptionKinds().
3044 * Currently, the option kinds are:
3045 * - 'registered' - preferences which are registered in core MediaWiki or
3046 * by extensions using the UserGetDefaultOptions hook.
3047 * - 'registered-multiselect' - as above, using the 'multiselect' type.
3048 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
3049 * - 'userjs' - preferences with names starting with 'userjs-', intended to
3050 * be used by user scripts.
3051 * - 'special' - "preferences" that are not accessible via User::getOptions
3052 * or User::setOptions.
3053 * - 'unused' - preferences about which MediaWiki doesn't know anything.
3054 * These are usually legacy options, removed in newer versions.
3056 * The API (and possibly others) use this function to determine the possible
3057 * option types for validation purposes, so make sure to update this when a
3058 * new option kind is added.
3060 * @see User::getOptionKinds
3061 * @return array Option kinds
3063 public static function listOptionKinds() {
3066 'registered-multiselect',
3067 'registered-checkmatrix',
3075 * Return an associative array mapping preferences keys to the kind of a preference they're
3076 * used for. Different kinds are handled differently when setting or reading preferences.
3078 * See User::listOptionKinds for the list of valid option types that can be provided.
3080 * @see User::listOptionKinds
3081 * @param IContextSource $context
3082 * @param array $options Assoc. array with options keys to check as keys.
3083 * Defaults to $this->mOptions.
3084 * @return array The key => kind mapping data
3086 public function getOptionKinds( IContextSource
$context, $options = null ) {
3087 $this->loadOptions();
3088 if ( $options === null ) {
3089 $options = $this->mOptions
;
3092 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
3093 $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
3096 // Pull out the "special" options, so they don't get converted as
3097 // multiselect or checkmatrix.
3098 $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
3099 foreach ( $specialOptions as $name => $value ) {
3100 unset( $prefs[$name] );
3103 // Multiselect and checkmatrix options are stored in the database with
3104 // one key per option, each having a boolean value. Extract those keys.
3105 $multiselectOptions = [];
3106 foreach ( $prefs as $name => $info ) {
3107 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3108 ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField
::class ) ) {
3109 $opts = HTMLFormField
::flattenOptions( $info['options'] );
3110 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
3112 foreach ( $opts as $value ) {
3113 $multiselectOptions["$prefix$value"] = true;
3116 unset( $prefs[$name] );
3119 $checkmatrixOptions = [];
3120 foreach ( $prefs as $name => $info ) {
3121 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3122 ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix
::class ) ) {
3123 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3124 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3125 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
3127 foreach ( $columns as $column ) {
3128 foreach ( $rows as $row ) {
3129 $checkmatrixOptions["$prefix$column-$row"] = true;
3133 unset( $prefs[$name] );
3137 // $value is ignored
3138 foreach ( $options as $key => $value ) {
3139 if ( isset( $prefs[$key] ) ) {
3140 $mapping[$key] = 'registered';
3141 } elseif ( isset( $multiselectOptions[$key] ) ) {
3142 $mapping[$key] = 'registered-multiselect';
3143 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3144 $mapping[$key] = 'registered-checkmatrix';
3145 } elseif ( isset( $specialOptions[$key] ) ) {
3146 $mapping[$key] = 'special';
3147 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3148 $mapping[$key] = 'userjs';
3150 $mapping[$key] = 'unused';
3158 * Reset certain (or all) options to the site defaults
3160 * The optional parameter determines which kinds of preferences will be reset.
3161 * Supported values are everything that can be reported by getOptionKinds()
3162 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3164 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3165 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3166 * for backwards-compatibility.
3167 * @param IContextSource|null $context Context source used when $resetKinds
3168 * does not contain 'all', passed to getOptionKinds().
3169 * Defaults to RequestContext::getMain() when null.
3171 public function resetOptions(
3172 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3173 IContextSource
$context = null
3176 $defaultOptions = self
::getDefaultOptions();
3178 if ( !is_array( $resetKinds ) ) {
3179 $resetKinds = [ $resetKinds ];
3182 if ( in_array( 'all', $resetKinds ) ) {
3183 $newOptions = $defaultOptions;
3185 if ( $context === null ) {
3186 $context = RequestContext
::getMain();
3189 $optionKinds = $this->getOptionKinds( $context );
3190 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3193 // Use default values for the options that should be deleted, and
3194 // copy old values for the ones that shouldn't.
3195 foreach ( $this->mOptions
as $key => $value ) {
3196 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3197 if ( array_key_exists( $key, $defaultOptions ) ) {
3198 $newOptions[$key] = $defaultOptions[$key];
3201 $newOptions[$key] = $value;
3206 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3208 $this->mOptions
= $newOptions;
3209 $this->mOptionsLoaded
= true;
3213 * Get the user's preferred date format.
3214 * @return string User's preferred date format
3216 public function getDatePreference() {
3217 // Important migration for old data rows
3218 if ( is_null( $this->mDatePreference
) ) {
3220 $value = $this->getOption( 'date' );
3221 $map = $wgLang->getDatePreferenceMigrationMap();
3222 if ( isset( $map[$value] ) ) {
3223 $value = $map[$value];
3225 $this->mDatePreference
= $value;
3227 return $this->mDatePreference
;
3231 * Determine based on the wiki configuration and the user's options,
3232 * whether this user must be over HTTPS no matter what.
3236 public function requiresHTTPS() {
3237 global $wgSecureLogin;
3238 if ( !$wgSecureLogin ) {
3241 $https = $this->getBoolOption( 'prefershttps' );
3242 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3244 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3251 * Get the user preferred stub threshold
3255 public function getStubThreshold() {
3256 global $wgMaxArticleSize; # Maximum article size, in Kb
3257 $threshold = $this->getIntOption( 'stubthreshold' );
3258 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3259 // If they have set an impossible value, disable the preference
3260 // so we can use the parser cache again.
3267 * Get the permissions this user has.
3268 * @return string[] permission names
3270 public function getRights() {
3271 if ( is_null( $this->mRights
) ) {
3272 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3273 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3275 // Deny any rights denied by the user's session, unless this
3276 // endpoint has no sessions.
3277 if ( !defined( 'MW_NO_SESSION' ) ) {
3278 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3279 if ( $allowedRights !== null ) {
3280 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3284 // Force reindexation of rights when a hook has unset one of them
3285 $this->mRights
= array_values( array_unique( $this->mRights
) );
3287 // If block disables login, we should also remove any
3288 // extra rights blocked users might have, in case the
3289 // blocked user has a pre-existing session (T129738).
3290 // This is checked here for cases where people only call
3291 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3292 // to give a better error message in the common case.
3293 $config = RequestContext
::getMain()->getConfig();
3295 $this->isLoggedIn() &&
3296 $config->get( 'BlockDisablesLogin' ) &&
3300 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3303 return $this->mRights
;
3307 * Get the list of explicit group memberships this user has.
3308 * The implicit * and user groups are not included.
3309 * @return array Array of String internal group names
3311 public function getGroups() {
3313 $this->loadGroups();
3314 return array_keys( $this->mGroupMemberships
);
3318 * Get the list of explicit group memberships this user has, stored as
3319 * UserGroupMembership objects. Implicit groups are not included.
3321 * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
3324 public function getGroupMemberships() {
3326 $this->loadGroups();
3327 return $this->mGroupMemberships
;
3331 * Get the list of implicit group memberships this user has.
3332 * This includes all explicit groups, plus 'user' if logged in,
3333 * '*' for all accounts, and autopromoted groups
3334 * @param bool $recache Whether to avoid the cache
3335 * @return array Array of String internal group names
3337 public function getEffectiveGroups( $recache = false ) {
3338 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3339 $this->mEffectiveGroups
= array_unique( array_merge(
3340 $this->getGroups(), // explicit groups
3341 $this->getAutomaticGroups( $recache ) // implicit groups
3343 // Avoid PHP 7.1 warning of passing $this by reference
3345 // Hook for additional groups
3346 Hooks
::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups
] );
3347 // Force reindexation of groups when a hook has unset one of them
3348 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3350 return $this->mEffectiveGroups
;
3354 * Get the list of implicit group memberships this user has.
3355 * This includes 'user' if logged in, '*' for all accounts,
3356 * and autopromoted groups
3357 * @param bool $recache Whether to avoid the cache
3358 * @return array Array of String internal group names
3360 public function getAutomaticGroups( $recache = false ) {
3361 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3362 $this->mImplicitGroups
= [ '*' ];
3363 if ( $this->getId() ) {
3364 $this->mImplicitGroups
[] = 'user';
3366 $this->mImplicitGroups
= array_unique( array_merge(
3367 $this->mImplicitGroups
,
3368 Autopromote
::getAutopromoteGroups( $this )
3372 // Assure data consistency with rights/groups,
3373 // as getEffectiveGroups() depends on this function
3374 $this->mEffectiveGroups
= null;
3377 return $this->mImplicitGroups
;
3381 * Returns the groups the user has belonged to.
3383 * The user may still belong to the returned groups. Compare with getGroups().
3385 * The function will not return groups the user had belonged to before MW 1.17
3387 * @return array Names of the groups the user has belonged to.
3389 public function getFormerGroups() {
3392 if ( is_null( $this->mFormerGroups
) ) {
3393 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3394 ?
wfGetDB( DB_MASTER
)
3395 : wfGetDB( DB_REPLICA
);
3396 $res = $db->select( 'user_former_groups',
3398 [ 'ufg_user' => $this->mId
],
3400 $this->mFormerGroups
= [];
3401 foreach ( $res as $row ) {
3402 $this->mFormerGroups
[] = $row->ufg_group
;
3406 return $this->mFormerGroups
;
3410 * Get the user's edit count.
3411 * @return int|null Null for anonymous users
3413 public function getEditCount() {
3414 if ( !$this->getId() ) {
3418 if ( $this->mEditCount
=== null ) {
3419 /* Populate the count, if it has not been populated yet */
3420 $dbr = wfGetDB( DB_REPLICA
);
3421 // check if the user_editcount field has been initialized
3422 $count = $dbr->selectField(
3423 'user', 'user_editcount',
3424 [ 'user_id' => $this->mId
],
3428 if ( $count === null ) {
3429 // it has not been initialized. do so.
3430 $count = $this->initEditCount();
3432 $this->mEditCount
= $count;
3434 return (int)$this->mEditCount
;
3438 * Add the user to the given group. This takes immediate effect.
3439 * If the user is already in the group, the expiry time will be updated to the new
3440 * expiry time. (If $expiry is omitted or null, the membership will be altered to
3443 * @param string $group Name of the group to add
3444 * @param string $expiry Optional expiry timestamp in any format acceptable to
3445 * wfTimestamp(), or null if the group assignment should not expire
3448 public function addGroup( $group, $expiry = null ) {
3450 $this->loadGroups();
3453 $expiry = wfTimestamp( TS_MW
, $expiry );
3456 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
3460 // create the new UserGroupMembership and put it in the DB
3461 $ugm = new UserGroupMembership( $this->mId
, $group, $expiry );
3462 if ( !$ugm->insert( true ) ) {
3466 $this->mGroupMemberships
[$group] = $ugm;
3468 // Refresh the groups caches, and clear the rights cache so it will be
3469 // refreshed on the next call to $this->getRights().
3470 $this->getEffectiveGroups( true );
3471 $this->mRights
= null;
3473 $this->invalidateCache();
3479 * Remove the user from the given group.
3480 * This takes immediate effect.
3481 * @param string $group Name of the group to remove
3484 public function removeGroup( $group ) {
3487 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3491 $ugm = UserGroupMembership
::getMembership( $this->mId
, $group );
3492 // delete the membership entry
3493 if ( !$ugm ||
!$ugm->delete() ) {
3497 $this->loadGroups();
3498 unset( $this->mGroupMemberships
[$group] );
3500 // Refresh the groups caches, and clear the rights cache so it will be
3501 // refreshed on the next call to $this->getRights().
3502 $this->getEffectiveGroups( true );
3503 $this->mRights
= null;
3505 $this->invalidateCache();
3511 * Get whether the user is logged in
3514 public function isLoggedIn() {
3515 return $this->getId() != 0;
3519 * Get whether the user is anonymous
3522 public function isAnon() {
3523 return !$this->isLoggedIn();
3527 * @return bool Whether this user is flagged as being a bot role account
3530 public function isBot() {
3531 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3536 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3542 * Check if user is allowed to access a feature / make an action
3544 * @param string $permissions,... Permissions to test
3545 * @return bool True if user is allowed to perform *any* of the given actions
3547 public function isAllowedAny() {
3548 $permissions = func_get_args();
3549 foreach ( $permissions as $permission ) {
3550 if ( $this->isAllowed( $permission ) ) {
3559 * @param string $permissions,... Permissions to test
3560 * @return bool True if the user is allowed to perform *all* of the given actions
3562 public function isAllowedAll() {
3563 $permissions = func_get_args();
3564 foreach ( $permissions as $permission ) {
3565 if ( !$this->isAllowed( $permission ) ) {
3573 * Internal mechanics of testing a permission
3574 * @param string $action
3577 public function isAllowed( $action = '' ) {
3578 if ( $action === '' ) {
3579 return true; // In the spirit of DWIM
3581 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3582 // by misconfiguration: 0 == 'foo'
3583 return in_array( $action, $this->getRights(), true );
3587 * Check whether to enable recent changes patrol features for this user
3588 * @return bool True or false
3590 public function useRCPatrol() {
3591 global $wgUseRCPatrol;
3592 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3596 * Check whether to enable new pages patrol features for this user
3597 * @return bool True or false
3599 public function useNPPatrol() {
3600 global $wgUseRCPatrol, $wgUseNPPatrol;
3602 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3603 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3608 * Check whether to enable new files patrol features for this user
3609 * @return bool True or false
3611 public function useFilePatrol() {
3612 global $wgUseRCPatrol, $wgUseFilePatrol;
3614 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3615 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3620 * Get the WebRequest object to use with this object
3622 * @return WebRequest
3624 public function getRequest() {
3625 if ( $this->mRequest
) {
3626 return $this->mRequest
;
3634 * Check the watched status of an article.
3635 * @since 1.22 $checkRights parameter added
3636 * @param Title $title Title of the article to look at
3637 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3638 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3641 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3642 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3643 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3650 * @since 1.22 $checkRights parameter added
3651 * @param Title $title Title of the article to look at
3652 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3653 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3655 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3656 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3657 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3659 [ $title->getSubjectPage(), $title->getTalkPage() ]
3662 $this->invalidateCache();
3666 * Stop watching an article.
3667 * @since 1.22 $checkRights parameter added
3668 * @param Title $title Title of the article to look at
3669 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3670 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3672 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3673 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3674 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3675 $store->removeWatch( $this, $title->getSubjectPage() );
3676 $store->removeWatch( $this, $title->getTalkPage() );
3678 $this->invalidateCache();
3682 * Clear the user's notification timestamp for the given title.
3683 * If e-notif e-mails are on, they will receive notification mails on
3684 * the next change of the page if it's watched etc.
3685 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3686 * @param Title &$title Title of the article to look at
3687 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3689 public function clearNotification( &$title, $oldid = 0 ) {
3690 global $wgUseEnotif, $wgShowUpdatedMarker;
3692 // Do nothing if the database is locked to writes
3693 if ( wfReadOnly() ) {
3697 // Do nothing if not allowed to edit the watchlist
3698 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3702 // If we're working on user's talk page, we should update the talk page message indicator
3703 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3704 // Avoid PHP 7.1 warning of passing $this by reference
3706 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
3710 // Try to update the DB post-send and only if needed...
3711 DeferredUpdates
::addCallableUpdate( function () use ( $title, $oldid ) {
3712 if ( !$this->getNewtalk() ) {
3713 return; // no notifications to clear
3716 // Delete the last notifications (they stack up)
3717 $this->setNewtalk( false );
3719 // If there is a new, unseen, revision, use its timestamp
3721 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
3724 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
3729 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3733 if ( $this->isAnon() ) {
3734 // Nothing else to do...
3738 // Only update the timestamp if the page is being watched.
3739 // The query to find out if it is watched is cached both in memcached and per-invocation,
3740 // and when it does have to be executed, it can be on a replica DB
3741 // If this is the user's newtalk page, we always update the timestamp
3743 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3747 MediaWikiServices
::getInstance()->getWatchedItemStore()
3748 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
3752 * Resets all of the given user's page-change notification timestamps.
3753 * If e-notif e-mails are on, they will receive notification mails on
3754 * the next change of any watched page.
3755 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3757 public function clearAllNotifications() {
3758 global $wgUseEnotif, $wgShowUpdatedMarker;
3759 // Do nothing if not allowed to edit the watchlist
3760 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
3764 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3765 $this->setNewtalk( false );
3769 $id = $this->getId();
3774 $dbw = wfGetDB( DB_MASTER
);
3775 $asOfTimes = array_unique( $dbw->selectFieldValues(
3777 'wl_notificationtimestamp',
3778 [ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ],
3780 [ 'ORDER BY' => 'wl_notificationtimestamp DESC', 'LIMIT' => 500 ]
3782 if ( !$asOfTimes ) {
3785 // Immediately update the most recent touched rows, which hopefully covers what
3786 // the user sees on the watchlist page before pressing "mark all pages visited"....
3789 [ 'wl_notificationtimestamp' => null ],
3790 [ 'wl_user' => $id, 'wl_notificationtimestamp' => $asOfTimes ],
3793 // ...and finish the older ones in a post-send update with lag checks...
3794 DeferredUpdates
::addUpdate( new AutoCommitUpdate(
3797 function () use ( $dbw, $id ) {
3798 global $wgUpdateRowsPerQuery;
3800 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
3801 $ticket = $lbFactory->getEmptyTransactionTicket( __METHOD__
);
3802 $asOfTimes = array_unique( $dbw->selectFieldValues(
3804 'wl_notificationtimestamp',
3805 [ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ],
3808 foreach ( array_chunk( $asOfTimes, $wgUpdateRowsPerQuery ) as $asOfTimeBatch ) {
3811 [ 'wl_notificationtimestamp' => null ],
3812 [ 'wl_user' => $id, 'wl_notificationtimestamp' => $asOfTimeBatch ],
3815 $lbFactory->commitAndWaitForReplication( __METHOD__
, $ticket );
3819 // We also need to clear here the "you have new message" notification for the own
3820 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
3824 * Compute experienced level based on edit count and registration date.
3826 * @return string 'newcomer', 'learner', or 'experienced'
3828 public function getExperienceLevel() {
3829 global $wgLearnerEdits,
3830 $wgExperiencedUserEdits,
3831 $wgLearnerMemberSince,
3832 $wgExperiencedUserMemberSince;
3834 if ( $this->isAnon() ) {
3838 $editCount = $this->getEditCount();
3839 $registration = $this->getRegistration();
3841 $learnerRegistration = wfTimestamp( TS_MW
, $now - $wgLearnerMemberSince * 86400 );
3842 $experiencedRegistration = wfTimestamp( TS_MW
, $now - $wgExperiencedUserMemberSince * 86400 );
3845 $editCount < $wgLearnerEdits ||
3846 $registration > $learnerRegistration
3850 $editCount > $wgExperiencedUserEdits &&
3851 $registration <= $experiencedRegistration
3853 return 'experienced';
3860 * Set a cookie on the user's client. Wrapper for
3861 * WebResponse::setCookie
3862 * @deprecated since 1.27
3863 * @param string $name Name of the cookie to set
3864 * @param string $value Value to set
3865 * @param int $exp Expiration time, as a UNIX time value;
3866 * if 0 or not specified, use the default $wgCookieExpiration
3867 * @param bool $secure
3868 * true: Force setting the secure attribute when setting the cookie
3869 * false: Force NOT setting the secure attribute when setting the cookie
3870 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3871 * @param array $params Array of options sent passed to WebResponse::setcookie()
3872 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3875 protected function setCookie(
3876 $name, $value, $exp = 0, $secure = null, $params = [], $request = null
3878 wfDeprecated( __METHOD__
, '1.27' );
3879 if ( $request === null ) {
3880 $request = $this->getRequest();
3882 $params['secure'] = $secure;
3883 $request->response()->setCookie( $name, $value, $exp, $params );
3887 * Clear a cookie on the user's client
3888 * @deprecated since 1.27
3889 * @param string $name Name of the cookie to clear
3890 * @param bool $secure
3891 * true: Force setting the secure attribute when setting the cookie
3892 * false: Force NOT setting the secure attribute when setting the cookie
3893 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3894 * @param array $params Array of options sent passed to WebResponse::setcookie()
3896 protected function clearCookie( $name, $secure = null, $params = [] ) {
3897 wfDeprecated( __METHOD__
, '1.27' );
3898 $this->setCookie( $name, '', time() - 86400, $secure, $params );
3902 * Set an extended login cookie on the user's client. The expiry of the cookie
3903 * is controlled by the $wgExtendedLoginCookieExpiration configuration
3906 * @see User::setCookie
3908 * @deprecated since 1.27
3909 * @param string $name Name of the cookie to set
3910 * @param string $value Value to set
3911 * @param bool $secure
3912 * true: Force setting the secure attribute when setting the cookie
3913 * false: Force NOT setting the secure attribute when setting the cookie
3914 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3916 protected function setExtendedLoginCookie( $name, $value, $secure ) {
3917 global $wgExtendedLoginCookieExpiration, $wgCookieExpiration;
3919 wfDeprecated( __METHOD__
, '1.27' );
3922 $exp +
= $wgExtendedLoginCookieExpiration !== null
3923 ?
$wgExtendedLoginCookieExpiration
3924 : $wgCookieExpiration;
3926 $this->setCookie( $name, $value, $exp, $secure );
3930 * Persist this user's session (e.g. set cookies)
3932 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3934 * @param bool $secure Whether to force secure/insecure cookies or use default
3935 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3937 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3939 if ( 0 == $this->mId
) {
3943 $session = $this->getRequest()->getSession();
3944 if ( $request && $session->getRequest() !== $request ) {
3945 $session = $session->sessionWithRequest( $request );
3947 $delay = $session->delaySave();
3949 if ( !$session->getUser()->equals( $this ) ) {
3950 if ( !$session->canSetUser() ) {
3951 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3952 ->warning( __METHOD__
.
3953 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
3957 $session->setUser( $this );
3960 $session->setRememberUser( $rememberMe );
3961 if ( $secure !== null ) {
3962 $session->setForceHTTPS( $secure );
3965 $session->persist();
3967 ScopedCallback
::consume( $delay );
3971 * Log this user out.
3973 public function logout() {
3974 // Avoid PHP 7.1 warning of passing $this by reference
3976 if ( Hooks
::run( 'UserLogout', [ &$user ] ) ) {
3982 * Clear the user's session, and reset the instance cache.
3985 public function doLogout() {
3986 $session = $this->getRequest()->getSession();
3987 if ( !$session->canSetUser() ) {
3988 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3989 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
3990 $error = 'immutable';
3991 } elseif ( !$session->getUser()->equals( $this ) ) {
3992 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3993 ->warning( __METHOD__
.
3994 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
3996 // But we still may as well make this user object anon
3997 $this->clearInstanceCache( 'defaults' );
3998 $error = 'wronguser';
4000 $this->clearInstanceCache( 'defaults' );
4001 $delay = $session->delaySave();
4002 $session->unpersist(); // Clear cookies (T127436)
4003 $session->setLoggedOutTimestamp( time() );
4004 $session->setUser( new User
);
4005 $session->set( 'wsUserID', 0 ); // Other code expects this
4006 $session->resetAllTokens();
4007 ScopedCallback
::consume( $delay );
4010 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
4011 'event' => 'logout',
4012 'successful' => $error === false,
4013 'status' => $error ?
: 'success',
4018 * Save this user's settings into the database.
4019 * @todo Only rarely do all these fields need to be set!
4021 public function saveSettings() {
4022 if ( wfReadOnly() ) {
4023 // @TODO: caller should deal with this instead!
4024 // This should really just be an exception.
4025 MWExceptionHandler
::logException( new DBExpectedError(
4027 "Could not update user with ID '{$this->mId}'; DB is read-only."
4033 if ( 0 == $this->mId
) {
4037 // Get a new user_touched that is higher than the old one.
4038 // This will be used for a CAS check as a last-resort safety
4039 // check against race conditions and replica DB lag.
4040 $newTouched = $this->newTouchedTimestamp();
4042 $dbw = wfGetDB( DB_MASTER
);
4043 $dbw->update( 'user',
4045 'user_name' => $this->mName
,
4046 'user_real_name' => $this->mRealName
,
4047 'user_email' => $this->mEmail
,
4048 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4049 'user_touched' => $dbw->timestamp( $newTouched ),
4050 'user_token' => strval( $this->mToken
),
4051 'user_email_token' => $this->mEmailToken
,
4052 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
4053 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
4054 'user_id' => $this->mId
,
4058 if ( !$dbw->affectedRows() ) {
4059 // Maybe the problem was a missed cache update; clear it to be safe
4060 $this->clearSharedCache( 'refresh' );
4061 // User was changed in the meantime or loaded with stale data
4062 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
4063 throw new MWException(
4064 "CAS update failed on user_touched for user ID '{$this->mId}' (read from $from);" .
4065 " the version of the user to be saved is older than the current version."
4069 $this->mTouched
= $newTouched;
4070 $this->saveOptions();
4072 Hooks
::run( 'UserSaveSettings', [ $this ] );
4073 $this->clearSharedCache();
4074 $this->getUserPage()->invalidateCache();
4078 * If only this user's username is known, and it exists, return the user ID.
4080 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
4083 public function idForName( $flags = 0 ) {
4084 $s = trim( $this->getName() );
4089 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
4090 ?
wfGetDB( DB_MASTER
)
4091 : wfGetDB( DB_REPLICA
);
4093 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
4094 ?
[ 'LOCK IN SHARE MODE' ]
4097 $id = $db->selectField( 'user',
4098 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
4104 * Add a user to the database, return the user object
4106 * @param string $name Username to add
4107 * @param array $params Array of Strings Non-default parameters to save to
4108 * the database as user_* fields:
4109 * - email: The user's email address.
4110 * - email_authenticated: The email authentication timestamp.
4111 * - real_name: The user's real name.
4112 * - options: An associative array of non-default options.
4113 * - token: Random authentication token. Do not set.
4114 * - registration: Registration timestamp. Do not set.
4116 * @return User|null User object, or null if the username already exists.
4118 public static function createNew( $name, $params = [] ) {
4119 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
4120 if ( isset( $params[$field] ) ) {
4121 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
4122 unset( $params[$field] );
4128 $user->setToken(); // init token
4129 if ( isset( $params['options'] ) ) {
4130 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
4131 unset( $params['options'] );
4133 $dbw = wfGetDB( DB_MASTER
);
4135 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4138 'user_name' => $name,
4139 'user_password' => $noPass,
4140 'user_newpassword' => $noPass,
4141 'user_email' => $user->mEmail
,
4142 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
4143 'user_real_name' => $user->mRealName
,
4144 'user_token' => strval( $user->mToken
),
4145 'user_registration' => $dbw->timestamp( $user->mRegistration
),
4146 'user_editcount' => 0,
4147 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4149 foreach ( $params as $name => $value ) {
4150 $fields["user_$name"] = $value;
4152 $dbw->insert( 'user', $fields, __METHOD__
, [ 'IGNORE' ] );
4153 if ( $dbw->affectedRows() ) {
4154 $newUser = self
::newFromId( $dbw->insertId() );
4162 * Add this existing user object to the database. If the user already
4163 * exists, a fatal status object is returned, and the user object is
4164 * initialised with the data from the database.
4166 * Previously, this function generated a DB error due to a key conflict
4167 * if the user already existed. Many extension callers use this function
4168 * in code along the lines of:
4170 * $user = User::newFromName( $name );
4171 * if ( !$user->isLoggedIn() ) {
4172 * $user->addToDatabase();
4174 * // do something with $user...
4176 * However, this was vulnerable to a race condition (T18020). By
4177 * initialising the user object if the user exists, we aim to support this
4178 * calling sequence as far as possible.
4180 * Note that if the user exists, this function will acquire a write lock,
4181 * so it is still advisable to make the call conditional on isLoggedIn(),
4182 * and to commit the transaction after calling.
4184 * @throws MWException
4187 public function addToDatabase() {
4189 if ( !$this->mToken
) {
4190 $this->setToken(); // init token
4193 if ( !is_string( $this->mName
) ) {
4194 throw new RuntimeException( "User name field is not set." );
4197 $this->mTouched
= $this->newTouchedTimestamp();
4199 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4201 $dbw = wfGetDB( DB_MASTER
);
4202 $dbw->insert( 'user',
4204 'user_name' => $this->mName
,
4205 'user_password' => $noPass,
4206 'user_newpassword' => $noPass,
4207 'user_email' => $this->mEmail
,
4208 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4209 'user_real_name' => $this->mRealName
,
4210 'user_token' => strval( $this->mToken
),
4211 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4212 'user_editcount' => 0,
4213 'user_touched' => $dbw->timestamp( $this->mTouched
),
4217 if ( !$dbw->affectedRows() ) {
4218 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4219 $this->mId
= $dbw->selectField(
4222 [ 'user_name' => $this->mName
],
4224 [ 'LOCK IN SHARE MODE' ]
4228 if ( $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4233 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
4234 "to insert user '{$this->mName}' row, but it was not present in select!" );
4236 return Status
::newFatal( 'userexists' );
4238 $this->mId
= $dbw->insertId();
4239 self
::$idCacheByName[$this->mName
] = $this->mId
;
4241 // Clear instance cache other than user table data, which is already accurate
4242 $this->clearInstanceCache();
4244 $this->saveOptions();
4245 return Status
::newGood();
4249 * If this user is logged-in and blocked,
4250 * block any IP address they've successfully logged in from.
4251 * @return bool A block was spread
4253 public function spreadAnyEditBlock() {
4254 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4255 return $this->spreadBlock();
4262 * If this (non-anonymous) user is blocked,
4263 * block the IP address they've successfully logged in from.
4264 * @return bool A block was spread
4266 protected function spreadBlock() {
4267 wfDebug( __METHOD__
. "()\n" );
4269 if ( $this->mId
== 0 ) {
4273 $userblock = Block
::newFromTarget( $this->getName() );
4274 if ( !$userblock ) {
4278 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4282 * Get whether the user is explicitly blocked from account creation.
4283 * @return bool|Block
4285 public function isBlockedFromCreateAccount() {
4286 $this->getBlockedStatus();
4287 if ( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
4288 return $this->mBlock
;
4291 # T15611: if the IP address the user is trying to create an account from is
4292 # blocked with createaccount disabled, prevent new account creation there even
4293 # when the user is logged in
4294 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4295 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4297 return $this->mBlockedFromCreateAccount
instanceof Block
4298 && $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
4299 ?
$this->mBlockedFromCreateAccount
4304 * Get whether the user is blocked from using Special:Emailuser.
4307 public function isBlockedFromEmailuser() {
4308 $this->getBlockedStatus();
4309 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
4313 * Get whether the user is allowed to create an account.
4316 public function isAllowedToCreateAccount() {
4317 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4321 * Get this user's personal page title.
4323 * @return Title User's personal page title
4325 public function getUserPage() {
4326 return Title
::makeTitle( NS_USER
, $this->getName() );
4330 * Get this user's talk page title.
4332 * @return Title User's talk page title
4334 public function getTalkPage() {
4335 $title = $this->getUserPage();
4336 return $title->getTalkPage();
4340 * Determine whether the user is a newbie. Newbies are either
4341 * anonymous IPs, or the most recently created accounts.
4344 public function isNewbie() {
4345 return !$this->isAllowed( 'autoconfirmed' );
4349 * Check to see if the given clear-text password is one of the accepted passwords
4350 * @deprecated since 1.27, use AuthManager instead
4351 * @param string $password User password
4352 * @return bool True if the given password is correct, otherwise False
4354 public function checkPassword( $password ) {
4355 $manager = AuthManager
::singleton();
4356 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4357 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4359 'username' => $this->getName(),
4360 'password' => $password,
4363 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4364 switch ( $res->status
) {
4365 case AuthenticationResponse
::PASS
:
4367 case AuthenticationResponse
::FAIL
:
4368 // Hope it's not a PreAuthenticationProvider that failed...
4369 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4370 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4373 throw new BadMethodCallException(
4374 'AuthManager returned a response unsupported by ' . __METHOD__
4380 * Check if the given clear-text password matches the temporary password
4381 * sent by e-mail for password reset operations.
4383 * @deprecated since 1.27, use AuthManager instead
4384 * @param string $plaintext
4385 * @return bool True if matches, false otherwise
4387 public function checkTemporaryPassword( $plaintext ) {
4388 // Can't check the temporary password individually.
4389 return $this->checkPassword( $plaintext );
4393 * Initialize (if necessary) and return a session token value
4394 * which can be used in edit forms to show that the user's
4395 * login credentials aren't being hijacked with a foreign form
4399 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4400 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4401 * @return MediaWiki\Session\Token The new edit token
4403 public function getEditTokenObject( $salt = '', $request = null ) {
4404 if ( $this->isAnon() ) {
4405 return new LoggedOutEditToken();
4409 $request = $this->getRequest();
4411 return $request->getSession()->getToken( $salt );
4415 * Initialize (if necessary) and return a session token value
4416 * which can be used in edit forms to show that the user's
4417 * login credentials aren't being hijacked with a foreign form
4420 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4423 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4424 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4425 * @return string The new edit token
4427 public function getEditToken( $salt = '', $request = null ) {
4428 return $this->getEditTokenObject( $salt, $request )->toString();
4432 * Get the embedded timestamp from a token.
4433 * @deprecated since 1.27, use \MediaWiki\Session\Token::getTimestamp instead.
4434 * @param string $val Input token
4437 public static function getEditTokenTimestamp( $val ) {
4438 wfDeprecated( __METHOD__
, '1.27' );
4439 return MediaWiki\Session\Token
::getTimestamp( $val );
4443 * Check given value against the token value stored in the session.
4444 * A match should confirm that the form was submitted from the
4445 * user's own login session, not a form submission from a third-party
4448 * @param string $val Input value to compare
4449 * @param string $salt Optional function-specific data for hashing
4450 * @param WebRequest|null $request Object to use or null to use $wgRequest
4451 * @param int $maxage Fail tokens older than this, in seconds
4452 * @return bool Whether the token matches
4454 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4455 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4459 * Check given value against the token value stored in the session,
4460 * ignoring the suffix.
4462 * @param string $val Input value to compare
4463 * @param string $salt Optional function-specific data for hashing
4464 * @param WebRequest|null $request Object to use or null to use $wgRequest
4465 * @param int $maxage Fail tokens older than this, in seconds
4466 * @return bool Whether the token matches
4468 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4469 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4470 return $this->matchEditToken( $val, $salt, $request, $maxage );
4474 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4475 * mail to the user's given address.
4477 * @param string $type Message to send, either "created", "changed" or "set"
4480 public function sendConfirmationMail( $type = 'created' ) {
4482 $expiration = null; // gets passed-by-ref and defined in next line.
4483 $token = $this->confirmationToken( $expiration );
4484 $url = $this->confirmationTokenUrl( $token );
4485 $invalidateURL = $this->invalidationTokenUrl( $token );
4486 $this->saveSettings();
4488 if ( $type == 'created' ||
$type === false ) {
4489 $message = 'confirmemail_body';
4490 } elseif ( $type === true ) {
4491 $message = 'confirmemail_body_changed';
4493 // Messages: confirmemail_body_changed, confirmemail_body_set
4494 $message = 'confirmemail_body_' . $type;
4497 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4498 wfMessage( $message,
4499 $this->getRequest()->getIP(),
4502 $wgLang->userTimeAndDate( $expiration, $this ),
4504 $wgLang->userDate( $expiration, $this ),
4505 $wgLang->userTime( $expiration, $this ) )->text() );
4509 * Send an e-mail to this user's account. Does not check for
4510 * confirmed status or validity.
4512 * @param string $subject Message subject
4513 * @param string $body Message body
4514 * @param User|null $from Optional sending user; if unspecified, default
4515 * $wgPasswordSender will be used.
4516 * @param string $replyto Reply-To address
4519 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4520 global $wgPasswordSender;
4522 if ( $from instanceof User
) {
4523 $sender = MailAddress
::newFromUser( $from );
4525 $sender = new MailAddress( $wgPasswordSender,
4526 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4528 $to = MailAddress
::newFromUser( $this );
4530 return UserMailer
::send( $to, $sender, $subject, $body, [
4531 'replyTo' => $replyto,
4536 * Generate, store, and return a new e-mail confirmation code.
4537 * A hash (unsalted, since it's used as a key) is stored.
4539 * @note Call saveSettings() after calling this function to commit
4540 * this change to the database.
4542 * @param string &$expiration Accepts the expiration time
4543 * @return string New token
4545 protected function confirmationToken( &$expiration ) {
4546 global $wgUserEmailConfirmationTokenExpiry;
4548 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4549 $expiration = wfTimestamp( TS_MW
, $expires );
4551 $token = MWCryptRand
::generateHex( 32 );
4552 $hash = md5( $token );
4553 $this->mEmailToken
= $hash;
4554 $this->mEmailTokenExpires
= $expiration;
4559 * Return a URL the user can use to confirm their email address.
4560 * @param string $token Accepts the email confirmation token
4561 * @return string New token URL
4563 protected function confirmationTokenUrl( $token ) {
4564 return $this->getTokenUrl( 'ConfirmEmail', $token );
4568 * Return a URL the user can use to invalidate their email address.
4569 * @param string $token Accepts the email confirmation token
4570 * @return string New token URL
4572 protected function invalidationTokenUrl( $token ) {
4573 return $this->getTokenUrl( 'InvalidateEmail', $token );
4577 * Internal function to format the e-mail validation/invalidation URLs.
4578 * This uses a quickie hack to use the
4579 * hardcoded English names of the Special: pages, for ASCII safety.
4581 * @note Since these URLs get dropped directly into emails, using the
4582 * short English names avoids insanely long URL-encoded links, which
4583 * also sometimes can get corrupted in some browsers/mailers
4584 * (T8957 with Gmail and Internet Explorer).
4586 * @param string $page Special page
4587 * @param string $token
4588 * @return string Formatted URL
4590 protected function getTokenUrl( $page, $token ) {
4591 // Hack to bypass localization of 'Special:'
4592 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4593 return $title->getCanonicalURL();
4597 * Mark the e-mail address confirmed.
4599 * @note Call saveSettings() after calling this function to commit the change.
4603 public function confirmEmail() {
4604 // Check if it's already confirmed, so we don't touch the database
4605 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4606 if ( !$this->isEmailConfirmed() ) {
4607 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4608 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4614 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4615 * address if it was already confirmed.
4617 * @note Call saveSettings() after calling this function to commit the change.
4618 * @return bool Returns true
4620 public function invalidateEmail() {
4622 $this->mEmailToken
= null;
4623 $this->mEmailTokenExpires
= null;
4624 $this->setEmailAuthenticationTimestamp( null );
4626 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4631 * Set the e-mail authentication timestamp.
4632 * @param string $timestamp TS_MW timestamp
4634 public function setEmailAuthenticationTimestamp( $timestamp ) {
4636 $this->mEmailAuthenticated
= $timestamp;
4637 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4641 * Is this user allowed to send e-mails within limits of current
4642 * site configuration?
4645 public function canSendEmail() {
4646 global $wgEnableEmail, $wgEnableUserEmail;
4647 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4650 $canSend = $this->isEmailConfirmed();
4651 // Avoid PHP 7.1 warning of passing $this by reference
4653 Hooks
::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
4658 * Is this user allowed to receive e-mails within limits of current
4659 * site configuration?
4662 public function canReceiveEmail() {
4663 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4667 * Is this user's e-mail address valid-looking and confirmed within
4668 * limits of the current site configuration?
4670 * @note If $wgEmailAuthentication is on, this may require the user to have
4671 * confirmed their address by returning a code or using a password
4672 * sent to the address from the wiki.
4676 public function isEmailConfirmed() {
4677 global $wgEmailAuthentication;
4679 // Avoid PHP 7.1 warning of passing $this by reference
4682 if ( Hooks
::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
4683 if ( $this->isAnon() ) {
4686 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4689 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4699 * Check whether there is an outstanding request for e-mail confirmation.
4702 public function isEmailConfirmationPending() {
4703 global $wgEmailAuthentication;
4704 return $wgEmailAuthentication &&
4705 !$this->isEmailConfirmed() &&
4706 $this->mEmailToken
&&
4707 $this->mEmailTokenExpires
> wfTimestamp();
4711 * Get the timestamp of account creation.
4713 * @return string|bool|null Timestamp of account creation, false for
4714 * non-existent/anonymous user accounts, or null if existing account
4715 * but information is not in database.
4717 public function getRegistration() {
4718 if ( $this->isAnon() ) {
4722 return $this->mRegistration
;
4726 * Get the timestamp of the first edit
4728 * @return string|bool Timestamp of first edit, or false for
4729 * non-existent/anonymous user accounts.
4731 public function getFirstEditTimestamp() {
4732 if ( $this->getId() == 0 ) {
4733 return false; // anons
4735 $dbr = wfGetDB( DB_REPLICA
);
4736 $time = $dbr->selectField( 'revision', 'rev_timestamp',
4737 [ 'rev_user' => $this->getId() ],
4739 [ 'ORDER BY' => 'rev_timestamp ASC' ]
4742 return false; // no edits
4744 return wfTimestamp( TS_MW
, $time );
4748 * Get the permissions associated with a given list of groups
4750 * @param array $groups Array of Strings List of internal group names
4751 * @return array Array of Strings List of permission key names for given groups combined
4753 public static function getGroupPermissions( $groups ) {
4754 global $wgGroupPermissions, $wgRevokePermissions;
4756 // grant every granted permission first
4757 foreach ( $groups as $group ) {
4758 if ( isset( $wgGroupPermissions[$group] ) ) {
4759 $rights = array_merge( $rights,
4760 // array_filter removes empty items
4761 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4764 // now revoke the revoked permissions
4765 foreach ( $groups as $group ) {
4766 if ( isset( $wgRevokePermissions[$group] ) ) {
4767 $rights = array_diff( $rights,
4768 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4771 return array_unique( $rights );
4775 * Get all the groups who have a given permission
4777 * @param string $role Role to check
4778 * @return array Array of Strings List of internal group names with the given permission
4780 public static function getGroupsWithPermission( $role ) {
4781 global $wgGroupPermissions;
4782 $allowedGroups = [];
4783 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4784 if ( self
::groupHasPermission( $group, $role ) ) {
4785 $allowedGroups[] = $group;
4788 return $allowedGroups;
4792 * Check, if the given group has the given permission
4794 * If you're wanting to check whether all users have a permission, use
4795 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4799 * @param string $group Group to check
4800 * @param string $role Role to check
4803 public static function groupHasPermission( $group, $role ) {
4804 global $wgGroupPermissions, $wgRevokePermissions;
4805 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4806 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4810 * Check if all users may be assumed to have the given permission
4812 * We generally assume so if the right is granted to '*' and isn't revoked
4813 * on any group. It doesn't attempt to take grants or other extension
4814 * limitations on rights into account in the general case, though, as that
4815 * would require it to always return false and defeat the purpose.
4816 * Specifically, session-based rights restrictions (such as OAuth or bot
4817 * passwords) are applied based on the current session.
4820 * @param string $right Right to check
4823 public static function isEveryoneAllowed( $right ) {
4824 global $wgGroupPermissions, $wgRevokePermissions;
4827 // Use the cached results, except in unit tests which rely on
4828 // being able change the permission mid-request
4829 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
4830 return $cache[$right];
4833 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
4834 $cache[$right] = false;
4838 // If it's revoked anywhere, then everyone doesn't have it
4839 foreach ( $wgRevokePermissions as $rights ) {
4840 if ( isset( $rights[$right] ) && $rights[$right] ) {
4841 $cache[$right] = false;
4846 // Remove any rights that aren't allowed to the global-session user,
4847 // unless there are no sessions for this endpoint.
4848 if ( !defined( 'MW_NO_SESSION' ) ) {
4849 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
4850 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
4851 $cache[$right] = false;
4856 // Allow extensions to say false
4857 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
4858 $cache[$right] = false;
4862 $cache[$right] = true;
4867 * Get the localized descriptive name for a group, if it exists
4868 * @deprecated since 1.29 Use UserGroupMembership::getGroupName instead
4870 * @param string $group Internal group name
4871 * @return string Localized descriptive group name
4873 public static function getGroupName( $group ) {
4874 wfDeprecated( __METHOD__
, '1.29' );
4875 return UserGroupMembership
::getGroupName( $group );
4879 * Get the localized descriptive name for a member of a group, if it exists
4880 * @deprecated since 1.29 Use UserGroupMembership::getGroupMemberName instead
4882 * @param string $group Internal group name
4883 * @param string $username Username for gender (since 1.19)
4884 * @return string Localized name for group member
4886 public static function getGroupMember( $group, $username = '#' ) {
4887 wfDeprecated( __METHOD__
, '1.29' );
4888 return UserGroupMembership
::getGroupMemberName( $group, $username );
4892 * Return the set of defined explicit groups.
4893 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4894 * are not included, as they are defined automatically, not in the database.
4895 * @return array Array of internal group names
4897 public static function getAllGroups() {
4898 global $wgGroupPermissions, $wgRevokePermissions;
4900 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4901 self
::getImplicitGroups()
4906 * Get a list of all available permissions.
4907 * @return string[] Array of permission names
4909 public static function getAllRights() {
4910 if ( self
::$mAllRights === false ) {
4911 global $wgAvailableRights;
4912 if ( count( $wgAvailableRights ) ) {
4913 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
4915 self
::$mAllRights = self
::$mCoreRights;
4917 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
4919 return self
::$mAllRights;
4923 * Get a list of implicit groups
4924 * @return array Array of Strings Array of internal group names
4926 public static function getImplicitGroups() {
4927 global $wgImplicitGroups;
4929 $groups = $wgImplicitGroups;
4930 # Deprecated, use $wgImplicitGroups instead
4931 Hooks
::run( 'UserGetImplicitGroups', [ &$groups ], '1.25' );
4937 * Get the title of a page describing a particular group
4938 * @deprecated since 1.29 Use UserGroupMembership::getGroupPage instead
4940 * @param string $group Internal group name
4941 * @return Title|bool Title of the page if it exists, false otherwise
4943 public static function getGroupPage( $group ) {
4944 wfDeprecated( __METHOD__
, '1.29' );
4945 return UserGroupMembership
::getGroupPage( $group );
4949 * Create a link to the group in HTML, if available;
4950 * else return the group name.
4951 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
4952 * make the link yourself if you need custom text
4954 * @param string $group Internal name of the group
4955 * @param string $text The text of the link
4956 * @return string HTML link to the group
4958 public static function makeGroupLinkHTML( $group, $text = '' ) {
4959 wfDeprecated( __METHOD__
, '1.29' );
4961 if ( $text == '' ) {
4962 $text = UserGroupMembership
::getGroupName( $group );
4964 $title = UserGroupMembership
::getGroupPage( $group );
4966 return MediaWikiServices
::getInstance()
4967 ->getLinkRenderer()->makeLink( $title, $text );
4969 return htmlspecialchars( $text );
4974 * Create a link to the group in Wikitext, if available;
4975 * else return the group name.
4976 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
4977 * make the link yourself if you need custom text
4979 * @param string $group Internal name of the group
4980 * @param string $text The text of the link
4981 * @return string Wikilink to the group
4983 public static function makeGroupLinkWiki( $group, $text = '' ) {
4984 wfDeprecated( __METHOD__
, '1.29' );
4986 if ( $text == '' ) {
4987 $text = UserGroupMembership
::getGroupName( $group );
4989 $title = UserGroupMembership
::getGroupPage( $group );
4991 $page = $title->getFullText();
4992 return "[[$page|$text]]";
4999 * Returns an array of the groups that a particular group can add/remove.
5001 * @param string $group The group to check for whether it can add/remove
5002 * @return array Array( 'add' => array( addablegroups ),
5003 * 'remove' => array( removablegroups ),
5004 * 'add-self' => array( addablegroups to self),
5005 * 'remove-self' => array( removable groups from self) )
5007 public static function changeableByGroup( $group ) {
5008 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
5017 if ( empty( $wgAddGroups[$group] ) ) {
5018 // Don't add anything to $groups
5019 } elseif ( $wgAddGroups[$group] === true ) {
5020 // You get everything
5021 $groups['add'] = self
::getAllGroups();
5022 } elseif ( is_array( $wgAddGroups[$group] ) ) {
5023 $groups['add'] = $wgAddGroups[$group];
5026 // Same thing for remove
5027 if ( empty( $wgRemoveGroups[$group] ) ) {
5029 } elseif ( $wgRemoveGroups[$group] === true ) {
5030 $groups['remove'] = self
::getAllGroups();
5031 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
5032 $groups['remove'] = $wgRemoveGroups[$group];
5035 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
5036 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
5037 foreach ( $wgGroupsAddToSelf as $key => $value ) {
5038 if ( is_int( $key ) ) {
5039 $wgGroupsAddToSelf['user'][] = $value;
5044 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
5045 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
5046 if ( is_int( $key ) ) {
5047 $wgGroupsRemoveFromSelf['user'][] = $value;
5052 // Now figure out what groups the user can add to him/herself
5053 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
5055 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
5056 // No idea WHY this would be used, but it's there
5057 $groups['add-self'] = self
::getAllGroups();
5058 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
5059 $groups['add-self'] = $wgGroupsAddToSelf[$group];
5062 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
5064 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
5065 $groups['remove-self'] = self
::getAllGroups();
5066 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
5067 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
5074 * Returns an array of groups that this user can add and remove
5075 * @return array Array( 'add' => array( addablegroups ),
5076 * 'remove' => array( removablegroups ),
5077 * 'add-self' => array( addablegroups to self),
5078 * 'remove-self' => array( removable groups from self) )
5080 public function changeableGroups() {
5081 if ( $this->isAllowed( 'userrights' ) ) {
5082 // This group gives the right to modify everything (reverse-
5083 // compatibility with old "userrights lets you change
5085 // Using array_merge to make the groups reindexed
5086 $all = array_merge( self
::getAllGroups() );
5095 // Okay, it's not so simple, we will have to go through the arrays
5102 $addergroups = $this->getEffectiveGroups();
5104 foreach ( $addergroups as $addergroup ) {
5105 $groups = array_merge_recursive(
5106 $groups, $this->changeableByGroup( $addergroup )
5108 $groups['add'] = array_unique( $groups['add'] );
5109 $groups['remove'] = array_unique( $groups['remove'] );
5110 $groups['add-self'] = array_unique( $groups['add-self'] );
5111 $groups['remove-self'] = array_unique( $groups['remove-self'] );
5117 * Deferred version of incEditCountImmediate()
5119 * This function, rather than incEditCountImmediate(), should be used for
5120 * most cases as it avoids potential deadlocks caused by concurrent editing.
5122 public function incEditCount() {
5123 wfGetDB( DB_MASTER
)->onTransactionPreCommitOrIdle(
5125 $this->incEditCountImmediate();
5132 * Increment the user's edit-count field.
5133 * Will have no effect for anonymous users.
5136 public function incEditCountImmediate() {
5137 if ( $this->isAnon() ) {
5141 $dbw = wfGetDB( DB_MASTER
);
5142 // No rows will be "affected" if user_editcount is NULL
5145 [ 'user_editcount=user_editcount+1' ],
5146 [ 'user_id' => $this->getId(), 'user_editcount IS NOT NULL' ],
5149 // Lazy initialization check...
5150 if ( $dbw->affectedRows() == 0 ) {
5151 // Now here's a goddamn hack...
5152 $dbr = wfGetDB( DB_REPLICA
);
5153 if ( $dbr !== $dbw ) {
5154 // If we actually have a replica DB server, the count is
5155 // at least one behind because the current transaction
5156 // has not been committed and replicated.
5157 $this->mEditCount
= $this->initEditCount( 1 );
5159 // But if DB_REPLICA is selecting the master, then the
5160 // count we just read includes the revision that was
5161 // just added in the working transaction.
5162 $this->mEditCount
= $this->initEditCount();
5165 if ( $this->mEditCount
=== null ) {
5166 $this->getEditCount();
5167 $dbr = wfGetDB( DB_REPLICA
);
5168 $this->mEditCount +
= ( $dbr !== $dbw ) ?
1 : 0;
5170 $this->mEditCount++
;
5173 // Edit count in user cache too
5174 $this->invalidateCache();
5178 * Initialize user_editcount from data out of the revision table
5180 * @param int $add Edits to add to the count from the revision table
5181 * @return int Number of edits
5183 protected function initEditCount( $add = 0 ) {
5184 // Pull from a replica DB to be less cruel to servers
5185 // Accuracy isn't the point anyway here
5186 $dbr = wfGetDB( DB_REPLICA
);
5187 $count = (int)$dbr->selectField(
5190 [ 'rev_user' => $this->getId() ],
5193 $count = $count +
$add;
5195 $dbw = wfGetDB( DB_MASTER
);
5198 [ 'user_editcount' => $count ],
5199 [ 'user_id' => $this->getId() ],
5207 * Get the description of a given right
5210 * @param string $right Right to query
5211 * @return string Localized description of the right
5213 public static function getRightDescription( $right ) {
5214 $key = "right-$right";
5215 $msg = wfMessage( $key );
5216 return $msg->isDisabled() ?
$right : $msg->text();
5220 * Get the name of a given grant
5223 * @param string $grant Grant to query
5224 * @return string Localized name of the grant
5226 public static function getGrantName( $grant ) {
5227 $key = "grant-$grant";
5228 $msg = wfMessage( $key );
5229 return $msg->isDisabled() ?
$grant : $msg->text();
5233 * Add a newuser log entry for this user.
5234 * Before 1.19 the return value was always true.
5236 * @deprecated since 1.27, AuthManager handles logging
5237 * @param string|bool $action Account creation type.
5238 * - String, one of the following values:
5239 * - 'create' for an anonymous user creating an account for himself.
5240 * This will force the action's performer to be the created user itself,
5241 * no matter the value of $wgUser
5242 * - 'create2' for a logged in user creating an account for someone else
5243 * - 'byemail' when the created user will receive its password by e-mail
5244 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5245 * - Boolean means whether the account was created by e-mail (deprecated):
5246 * - true will be converted to 'byemail'
5247 * - false will be converted to 'create' if this object is the same as
5248 * $wgUser and to 'create2' otherwise
5249 * @param string $reason User supplied reason
5252 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5253 return true; // disabled
5257 * Add an autocreate newuser log entry for this user
5258 * Used by things like CentralAuth and perhaps other authplugins.
5259 * Consider calling addNewUserLogEntry() directly instead.
5261 * @deprecated since 1.27, AuthManager handles logging
5264 public function addNewUserLogEntryAutoCreate() {
5265 $this->addNewUserLogEntry( 'autocreate' );
5271 * Load the user options either from cache, the database or an array
5273 * @param array $data Rows for the current user out of the user_properties table
5275 protected function loadOptions( $data = null ) {
5280 if ( $this->mOptionsLoaded
) {
5284 $this->mOptions
= self
::getDefaultOptions();
5286 if ( !$this->getId() ) {
5287 // For unlogged-in users, load language/variant options from request.
5288 // There's no need to do it for logged-in users: they can set preferences,
5289 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5290 // so don't override user's choice (especially when the user chooses site default).
5291 $variant = $wgContLang->getDefaultVariant();
5292 $this->mOptions
['variant'] = $variant;
5293 $this->mOptions
['language'] = $variant;
5294 $this->mOptionsLoaded
= true;
5298 // Maybe load from the object
5299 if ( !is_null( $this->mOptionOverrides
) ) {
5300 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5301 foreach ( $this->mOptionOverrides
as $key => $value ) {
5302 $this->mOptions
[$key] = $value;
5305 if ( !is_array( $data ) ) {
5306 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5307 // Load from database
5308 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5309 ?
wfGetDB( DB_MASTER
)
5310 : wfGetDB( DB_REPLICA
);
5312 $res = $dbr->select(
5314 [ 'up_property', 'up_value' ],
5315 [ 'up_user' => $this->getId() ],
5319 $this->mOptionOverrides
= [];
5321 foreach ( $res as $row ) {
5322 // Convert '0' to 0. PHP's boolean conversion considers them both
5323 // false, but e.g. JavaScript considers the former as true.
5324 // @todo: T54542 Somehow determine the desired type (string/int/bool)
5325 // and convert all values here.
5326 if ( $row->up_value
=== '0' ) {
5329 $data[$row->up_property
] = $row->up_value
;
5333 // Convert the email blacklist from a new line delimited string
5334 // to an array of ids.
5335 if ( isset( $data['email-blacklist'] ) && $data['email-blacklist'] ) {
5336 $data['email-blacklist'] = array_map( 'intval', explode( "\n", $data['email-blacklist'] ) );
5339 foreach ( $data as $property => $value ) {
5340 $this->mOptionOverrides
[$property] = $value;
5341 $this->mOptions
[$property] = $value;
5345 $this->mOptionsLoaded
= true;
5347 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5351 * Saves the non-default options for this user, as previously set e.g. via
5352 * setOption(), in the database's "user_properties" (preferences) table.
5353 * Usually used via saveSettings().
5355 protected function saveOptions() {
5356 $this->loadOptions();
5358 // Not using getOptions(), to keep hidden preferences in database
5359 $saveOptions = $this->mOptions
;
5361 // Convert usernames to ids.
5362 if ( isset( $this->mOptions
['email-blacklist'] ) ) {
5363 if ( $this->mOptions
['email-blacklist'] ) {
5364 $value = $this->mOptions
['email-blacklist'];
5365 // Email Blacklist may be an array of ids or a string of new line
5366 // delimnated user names.
5367 if ( is_array( $value ) ) {
5368 $ids = array_filter( $value, 'is_numeric' );
5370 $lookup = CentralIdLookup
::factory();
5371 $ids = $lookup->centralIdsFromNames( explode( "\n", $value ), $this );
5373 $this->mOptions
['email-blacklist'] = $ids;
5374 $saveOptions['email-blacklist'] = implode( "\n", $this->mOptions
['email-blacklist'] );
5376 // If the blacklist is empty, set it to null rather than an empty string.
5377 $this->mOptions
['email-blacklist'] = null;
5381 // Allow hooks to abort, for instance to save to a global profile.
5382 // Reset options to default state before saving.
5383 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5387 $userId = $this->getId();
5389 $insert_rows = []; // all the new preference rows
5390 foreach ( $saveOptions as $key => $value ) {
5391 // Don't bother storing default values
5392 $defaultOption = self
::getDefaultOption( $key );
5393 if ( ( $defaultOption === null && $value !== false && $value !== null )
5394 ||
$value != $defaultOption
5397 'up_user' => $userId,
5398 'up_property' => $key,
5399 'up_value' => $value,
5404 $dbw = wfGetDB( DB_MASTER
);
5406 $res = $dbw->select( 'user_properties',
5407 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5409 // Find prior rows that need to be removed or updated. These rows will
5410 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5412 foreach ( $res as $row ) {
5413 if ( !isset( $saveOptions[$row->up_property
] )
5414 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5416 $keysDelete[] = $row->up_property
;
5420 if ( count( $keysDelete ) ) {
5421 // Do the DELETE by PRIMARY KEY for prior rows.
5422 // In the past a very large portion of calls to this function are for setting
5423 // 'rememberpassword' for new accounts (a preference that has since been removed).
5424 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5425 // caused gap locks on [max user ID,+infinity) which caused high contention since
5426 // updates would pile up on each other as they are for higher (newer) user IDs.
5427 // It might not be necessary these days, but it shouldn't hurt either.
5428 $dbw->delete( 'user_properties',
5429 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5431 // Insert the new preference rows
5432 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5436 * Lazily instantiate and return a factory object for making passwords
5438 * @deprecated since 1.27, create a PasswordFactory directly instead
5439 * @return PasswordFactory
5441 public static function getPasswordFactory() {
5442 wfDeprecated( __METHOD__
, '1.27' );
5443 $ret = new PasswordFactory();
5444 $ret->init( RequestContext
::getMain()->getConfig() );
5449 * Provide an array of HTML5 attributes to put on an input element
5450 * intended for the user to enter a new password. This may include
5451 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
5453 * Do *not* use this when asking the user to enter his current password!
5454 * Regardless of configuration, users may have invalid passwords for whatever
5455 * reason (e.g., they were set before requirements were tightened up).
5456 * Only use it when asking for a new password, like on account creation or
5459 * Obviously, you still need to do server-side checking.
5461 * NOTE: A combination of bugs in various browsers means that this function
5462 * actually just returns array() unconditionally at the moment. May as
5463 * well keep it around for when the browser bugs get fixed, though.
5465 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
5467 * @deprecated since 1.27
5468 * @return array Array of HTML attributes suitable for feeding to
5469 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
5470 * That will get confused by the boolean attribute syntax used.)
5472 public static function passwordChangeInputAttribs() {
5473 global $wgMinimalPasswordLength;
5475 if ( $wgMinimalPasswordLength == 0 ) {
5479 # Note that the pattern requirement will always be satisfied if the
5480 # input is empty, so we need required in all cases.
5482 # @todo FIXME: T25769: This needs to not claim the password is required
5483 # if e-mail confirmation is being used. Since HTML5 input validation
5484 # is b0rked anyway in some browsers, just return nothing. When it's
5485 # re-enabled, fix this code to not output required for e-mail
5487 # $ret = array( 'required' );
5490 # We can't actually do this right now, because Opera 9.6 will print out
5491 # the entered password visibly in its error message! When other
5492 # browsers add support for this attribute, or Opera fixes its support,
5493 # we can add support with a version check to avoid doing this on Opera
5494 # versions where it will be a problem. Reported to Opera as
5495 # DSK-262266, but they don't have a public bug tracker for us to follow.
5497 if ( $wgMinimalPasswordLength > 1 ) {
5498 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
5499 $ret['title'] = wfMessage( 'passwordtooshort' )
5500 ->numParams( $wgMinimalPasswordLength )->text();
5508 * Return the list of user fields that should be selected to create
5509 * a new user object.
5510 * @deprecated since 1.31, use self::getQueryInfo() instead.
5513 public static function selectFields() {
5514 wfDeprecated( __METHOD__
, '1.31' );
5522 'user_email_authenticated',
5524 'user_email_token_expires',
5525 'user_registration',
5531 * Return the tables, fields, and join conditions to be selected to create
5532 * a new user object.
5534 * @return array With three keys:
5535 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
5536 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
5537 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
5539 public static function getQueryInfo() {
5541 'tables' => [ 'user' ],
5549 'user_email_authenticated',
5551 'user_email_token_expires',
5552 'user_registration',
5560 * Factory function for fatal permission-denied errors
5563 * @param string $permission User right required
5566 static function newFatalPermissionDeniedStatus( $permission ) {
5570 foreach ( self
::getGroupsWithPermission( $permission ) as $group ) {
5571 $groups[] = UserGroupMembership
::getLink( $group, RequestContext
::getMain(), 'wiki' );
5575 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5577 return Status
::newFatal( 'badaccess-group0' );
5582 * Get a new instance of this user that was loaded from the master via a locking read
5584 * Use this instead of the main context User when updating that user. This avoids races
5585 * where that user was loaded from a replica DB or even the master but without proper locks.
5587 * @return User|null Returns null if the user was not found in the DB
5590 public function getInstanceForUpdate() {
5591 if ( !$this->getId() ) {
5592 return null; // anon
5595 $user = self
::newFromId( $this->getId() );
5596 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5604 * Checks if two user objects point to the same user.
5610 public function equals( User
$user ) {
5611 return $this->getName() === $user->getName();