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 Wikimedia\ScopedCallback
;
32 * String Some punctuation to prevent editing from broken text-mangling proxies.
33 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
36 define( 'EDIT_TOKEN_SUFFIX', Token
::SUFFIX
);
39 * The User object encapsulates all of the user-specific settings (user_id,
40 * name, rights, email address, options, last login time). Client
41 * classes use the getXXX() functions to access these fields. These functions
42 * do all the work of determining whether the user is logged in,
43 * whether the requested option can be satisfied from cookies or
44 * whether a database query is needed. Most of the settings needed
45 * for rendering normal pages are set in the cookie to minimize use
48 class User
implements IDBAccessObject
{
50 * @const int Number of characters in user_token field.
52 const TOKEN_LENGTH
= 32;
55 * @const string An invalid value for user_token
57 const INVALID_TOKEN
= '*** INVALID ***';
60 * Global constant made accessible as class constants so that autoloader
62 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
64 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
67 * @const int Serialized record version.
72 * Exclude user options that are set to their default value.
75 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
80 const CHECK_USER_RIGHTS
= true;
85 const IGNORE_USER_RIGHTS
= false;
88 * Array of Strings List of member variables which are saved to the
89 * shared cache (memcached). Any operation which changes the
90 * corresponding database fields must call a cache-clearing function.
93 protected static $mCacheVars = [
101 'mEmailAuthenticated',
103 'mEmailTokenExpires',
108 // user_properties table
113 * Array of Strings Core rights.
114 * Each of these should have a corresponding message of the form
118 protected static $mCoreRights = [
149 'editusercssjs', # deprecated
162 'move-categorypages',
163 'move-rootuserpages',
167 'override-export-depth',
190 'userrights-interwiki',
198 * String Cached results of getAllRights()
200 protected static $mAllRights = false;
202 /** Cache variables */
213 /** @var string TS_MW timestamp from the DB */
215 /** @var string TS_MW timestamp from cache */
216 protected $mQuickTouched;
220 public $mEmailAuthenticated;
222 protected $mEmailToken;
224 protected $mEmailTokenExpires;
226 protected $mRegistration;
228 protected $mEditCount;
232 protected $mOptionOverrides;
236 * Bool Whether the cache variables have been loaded.
239 public $mOptionsLoaded;
242 * Array with already loaded items or true if all items have been loaded.
244 protected $mLoadedItems = [];
248 * String Initialization data source if mLoadedItems!==true. May be one of:
249 * - 'defaults' anonymous user initialised from class defaults
250 * - 'name' initialise from mName
251 * - 'id' initialise from mId
252 * - 'session' log in from session if possible
254 * Use the User::newFrom*() family of functions to set this.
259 * Lazy-initialized variables, invalidated with clearInstanceCache
263 protected $mDatePreference;
271 protected $mBlockreason;
273 protected $mEffectiveGroups;
275 protected $mImplicitGroups;
277 protected $mFormerGroups;
279 protected $mGlobalBlock;
296 protected $mAllowUsertalk;
299 private $mBlockedFromCreateAccount = false;
301 /** @var integer 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 integer $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 if ( wfGetLB()->hasOrMadeRecentMasterChanges() ) {
388 $flags |
= self
::READ_LATEST
;
389 $this->queryFlagsUsed
= $flags;
392 $this->mId
= self
::idFromName( $this->mName
, $flags );
394 // Nonexistent user placeholder object
395 $this->loadDefaults( $this->mName
);
397 $this->loadFromId( $flags );
401 $this->loadFromId( $flags );
404 if ( !$this->loadFromSession() ) {
405 // Loading from session failed. Load defaults.
406 $this->loadDefaults();
408 Hooks
::run( 'UserLoadAfterLoadFromSession', [ $this ] );
411 throw new UnexpectedValueException(
412 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
417 * Load user table data, given mId has already been set.
418 * @param integer $flags User::READ_* constant bitfield
419 * @return bool False if the ID does not exist, true otherwise
421 public function loadFromId( $flags = self
::READ_NORMAL
) {
422 if ( $this->mId
== 0 ) {
423 // Anonymous users are not in the database (don't need cache)
424 $this->loadDefaults();
428 // Try cache (unless this needs data from the master DB).
429 // NOTE: if this thread called saveSettings(), the cache was cleared.
430 $latest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
432 if ( !$this->loadFromDatabase( $flags ) ) {
433 // Can't load from ID
437 $this->loadFromCache();
440 $this->mLoadedItems
= true;
441 $this->queryFlagsUsed
= $flags;
448 * @param string $wikiId
449 * @param integer $userId
451 public static function purge( $wikiId, $userId ) {
452 $cache = ObjectCache
::getMainWANInstance();
453 $key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
454 $cache->delete( $key );
459 * @param WANObjectCache $cache
462 protected function getCacheKey( WANObjectCache
$cache ) {
463 return $cache->makeGlobalKey( 'user', 'id', wfWikiID(), $this->mId
);
467 * Load user data from shared cache, given mId has already been set.
472 protected function loadFromCache() {
473 $cache = ObjectCache
::getMainWANInstance();
474 $data = $cache->getWithSetCallback(
475 $this->getCacheKey( $cache ),
477 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
478 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
479 wfDebug( "User: cache miss for user {$this->mId}\n" );
481 $this->loadFromDatabase( self
::READ_NORMAL
);
483 $this->loadOptions();
486 foreach ( self
::$mCacheVars as $name ) {
487 $data[$name] = $this->$name;
490 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->mTouched
), $ttl );
495 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'version' => self
::VERSION
]
498 // Restore from cache
499 foreach ( self
::$mCacheVars as $name ) {
500 $this->$name = $data[$name];
506 /** @name newFrom*() static factory methods */
510 * Static factory method for creation from username.
512 * This is slightly less efficient than newFromId(), so use newFromId() if
513 * you have both an ID and a name handy.
515 * @param string $name Username, validated by Title::newFromText()
516 * @param string|bool $validate Validate username. Takes the same parameters as
517 * User::getCanonicalName(), except that true is accepted as an alias
518 * for 'valid', for BC.
520 * @return User|bool User object, or false if the username is invalid
521 * (e.g. if it contains illegal characters or is an IP address). If the
522 * username is not present in the database, the result will be a user object
523 * with a name, zero user ID and default settings.
525 public static function newFromName( $name, $validate = 'valid' ) {
526 if ( $validate === true ) {
529 $name = self
::getCanonicalName( $name, $validate );
530 if ( $name === false ) {
533 // Create unloaded user object
537 $u->setItemLoaded( 'name' );
543 * Static factory method for creation from a given user ID.
545 * @param int $id Valid user ID
546 * @return User The corresponding User object
548 public static function newFromId( $id ) {
552 $u->setItemLoaded( 'id' );
557 * Factory method to fetch whichever user has a given email confirmation code.
558 * This code is generated when an account is created or its e-mail address
561 * If the code is invalid or has expired, returns NULL.
563 * @param string $code Confirmation code
564 * @param int $flags User::READ_* bitfield
567 public static function newFromConfirmationCode( $code, $flags = 0 ) {
568 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
569 ?
wfGetDB( DB_MASTER
)
570 : wfGetDB( DB_REPLICA
);
572 $id = $db->selectField(
576 'user_email_token' => md5( $code ),
577 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
581 return $id ? User
::newFromId( $id ) : null;
585 * Create a new user object using data from session. If the login
586 * credentials are invalid, the result is an anonymous user.
588 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
591 public static function newFromSession( WebRequest
$request = null ) {
593 $user->mFrom
= 'session';
594 $user->mRequest
= $request;
599 * Create a new user object from a user row.
600 * The row should have the following fields from the user table in it:
601 * - either user_name or user_id to load further data if needed (or both)
603 * - all other fields (email, etc.)
604 * It is useless to provide the remaining fields if either user_id,
605 * user_name and user_real_name are not provided because the whole row
606 * will be loaded once more from the database when accessing them.
608 * @param stdClass $row A row from the user table
609 * @param array $data Further data to load into the object (see User::loadFromRow for valid keys)
612 public static function newFromRow( $row, $data = null ) {
614 $user->loadFromRow( $row, $data );
619 * Static factory method for creation of a "system" user from username.
621 * A "system" user is an account that's used to attribute logged actions
622 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
623 * might include the 'Maintenance script' or 'Conversion script' accounts
624 * used by various scripts in the maintenance/ directory or accounts such
625 * as 'MediaWiki message delivery' used by the MassMessage extension.
627 * This can optionally create the user if it doesn't exist, and "steal" the
628 * account if it does exist.
630 * "Stealing" an existing user is intended to make it impossible for normal
631 * authentication processes to use the account, effectively disabling the
632 * account for normal use:
633 * - Email is invalidated, to prevent account recovery by emailing a
634 * temporary password and to disassociate the account from the existing
636 * - The token is set to a magic invalid value, to kill existing sessions
637 * and to prevent $this->setToken() calls from resetting the token to a
639 * - SessionManager is instructed to prevent new sessions for the user, to
640 * do things like deauthorizing OAuth consumers.
641 * - AuthManager is instructed to revoke access, to invalidate or remove
642 * passwords and other credentials.
644 * @param string $name Username
645 * @param array $options Options are:
646 * - validate: As for User::getCanonicalName(), default 'valid'
647 * - create: Whether to create the user if it doesn't already exist, default true
648 * - steal: Whether to "disable" the account for normal use if it already
649 * exists, default false
653 public static function newSystemUser( $name, $options = [] ) {
655 'validate' => 'valid',
660 $name = self
::getCanonicalName( $name, $options['validate'] );
661 if ( $name === false ) {
665 $fields = self
::selectFields();
667 $dbw = wfGetDB( DB_MASTER
);
668 $row = $dbw->selectRow(
671 [ 'user_name' => $name ],
675 // No user. Create it?
676 return $options['create'] ? self
::createNew( $name ) : null;
678 $user = self
::newFromRow( $row );
680 // A user is considered to exist as a non-system user if it can
681 // authenticate, or has an email set, or has a non-invalid token.
682 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
683 AuthManager
::singleton()->userCanAuthenticate( $name )
685 // User exists. Steal it?
686 if ( !$options['steal'] ) {
690 AuthManager
::singleton()->revokeAccessForUser( $name );
692 $user->invalidateEmail();
693 $user->mToken
= self
::INVALID_TOKEN
;
694 $user->saveSettings();
695 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
704 * Get the username corresponding to a given user ID
705 * @param int $id User ID
706 * @return string|bool The corresponding username
708 public static function whoIs( $id ) {
709 return UserCache
::singleton()->getProp( $id, 'name' );
713 * Get the real name of a user given their user ID
715 * @param int $id User ID
716 * @return string|bool The corresponding user's real name
718 public static function whoIsReal( $id ) {
719 return UserCache
::singleton()->getProp( $id, 'real_name' );
723 * Get database id given a user name
724 * @param string $name Username
725 * @param integer $flags User::READ_* constant bitfield
726 * @return int|null The corresponding user's ID, or null if user is nonexistent
728 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
729 $nt = Title
::makeTitleSafe( NS_USER
, $name );
730 if ( is_null( $nt ) ) {
735 if ( !( $flags & self
::READ_LATEST
) && isset( self
::$idCacheByName[$name] ) ) {
736 return self
::$idCacheByName[$name];
739 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
740 $db = wfGetDB( $index );
745 [ 'user_name' => $nt->getText() ],
750 if ( $s === false ) {
753 $result = $s->user_id
;
756 self
::$idCacheByName[$name] = $result;
758 if ( count( self
::$idCacheByName ) > 1000 ) {
759 self
::$idCacheByName = [];
766 * Reset the cache used in idFromName(). For use in tests.
768 public static function resetIdByNameCache() {
769 self
::$idCacheByName = [];
773 * Does the string match an anonymous IP address?
775 * This function exists for username validation, in order to reject
776 * usernames which are similar in form to IP addresses. Strings such
777 * as 300.300.300.300 will return true because it looks like an IP
778 * address, despite not being strictly valid.
780 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
781 * address because the usemod software would "cloak" anonymous IP
782 * addresses like this, if we allowed accounts like this to be created
783 * new users could get the old edits of these anonymous users.
785 * @param string $name Name to match
788 public static function isIP( $name ) {
789 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
790 || IP
::isIPv6( $name );
794 * Is the input a valid username?
796 * Checks if the input is a valid username, we don't want an empty string,
797 * an IP address, anything that contains slashes (would mess up subpages),
798 * is longer than the maximum allowed username size or doesn't begin with
801 * @param string $name Name to match
804 public static function isValidUserName( $name ) {
805 global $wgContLang, $wgMaxNameChars;
808 || User
::isIP( $name )
809 ||
strpos( $name, '/' ) !== false
810 ||
strlen( $name ) > $wgMaxNameChars
811 ||
$name != $wgContLang->ucfirst( $name )
816 // Ensure that the name can't be misresolved as a different title,
817 // such as with extra namespace keys at the start.
818 $parsed = Title
::newFromText( $name );
819 if ( is_null( $parsed )
820 ||
$parsed->getNamespace()
821 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
825 // Check an additional blacklist of troublemaker characters.
826 // Should these be merged into the title char list?
827 $unicodeBlacklist = '/[' .
828 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
829 '\x{00a0}' . # non-breaking space
830 '\x{2000}-\x{200f}' . # various whitespace
831 '\x{2028}-\x{202f}' . # breaks and control chars
832 '\x{3000}' . # ideographic space
833 '\x{e000}-\x{f8ff}' . # private use
835 if ( preg_match( $unicodeBlacklist, $name ) ) {
843 * Usernames which fail to pass this function will be blocked
844 * from user login and new account registrations, but may be used
845 * internally by batch processes.
847 * If an account already exists in this form, login will be blocked
848 * by a failure to pass this function.
850 * @param string $name Name to match
853 public static function isUsableName( $name ) {
854 global $wgReservedUsernames;
855 // Must be a valid username, obviously ;)
856 if ( !self
::isValidUserName( $name ) ) {
860 static $reservedUsernames = false;
861 if ( !$reservedUsernames ) {
862 $reservedUsernames = $wgReservedUsernames;
863 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
866 // Certain names may be reserved for batch processes.
867 foreach ( $reservedUsernames as $reserved ) {
868 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
869 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
871 if ( $reserved == $name ) {
879 * Return the users who are members of the given group(s). In case of multiple groups,
880 * users who are members of at least one of them are returned.
882 * @param string|array $groups A single group name or an array of group names
883 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
884 * records; larger values are ignored.
885 * @param int $after ID the user to start after
886 * @return UserArrayFromResult
888 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
889 if ( $groups === [] ) {
890 return UserArrayFromResult
::newFromIDs( [] );
893 $groups = array_unique( (array)$groups );
894 $limit = min( 5000, $limit );
896 $conds = [ 'ug_group' => $groups ];
897 if ( $after !== null ) {
898 $conds[] = 'ug_user > ' . (int)$after;
901 $dbr = wfGetDB( DB_REPLICA
);
902 $ids = $dbr->selectFieldValues(
909 'ORDER BY' => 'ug_user',
913 return UserArray
::newFromIDs( $ids );
917 * Usernames which fail to pass this function will be blocked
918 * from new account registrations, but may be used internally
919 * either by batch processes or by user accounts which have
920 * already been created.
922 * Additional blacklisting may be added here rather than in
923 * isValidUserName() to avoid disrupting existing accounts.
925 * @param string $name String to match
928 public static function isCreatableName( $name ) {
929 global $wgInvalidUsernameCharacters;
931 // Ensure that the username isn't longer than 235 bytes, so that
932 // (at least for the builtin skins) user javascript and css files
933 // will work. (bug 23080)
934 if ( strlen( $name ) > 235 ) {
935 wfDebugLog( 'username', __METHOD__
.
936 ": '$name' invalid due to length" );
940 // Preg yells if you try to give it an empty string
941 if ( $wgInvalidUsernameCharacters !== '' ) {
942 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
943 wfDebugLog( 'username', __METHOD__
.
944 ": '$name' invalid due to wgInvalidUsernameCharacters" );
949 return self
::isUsableName( $name );
953 * Is the input a valid password for this user?
955 * @param string $password Desired password
958 public function isValidPassword( $password ) {
959 // simple boolean wrapper for getPasswordValidity
960 return $this->getPasswordValidity( $password ) === true;
964 * Given unvalidated password input, return error message on failure.
966 * @param string $password Desired password
967 * @return bool|string|array True on success, string or array of error message on failure
969 public function getPasswordValidity( $password ) {
970 $result = $this->checkPasswordValidity( $password );
971 if ( $result->isGood() ) {
975 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
976 $messages[] = $error['message'];
978 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
979 $messages[] = $warning['message'];
981 if ( count( $messages ) === 1 ) {
989 * Check if this is a valid password for this user
991 * Create a Status object based on the password's validity.
992 * The Status should be set to fatal if the user should not
993 * be allowed to log in, and should have any errors that
994 * would block changing the password.
996 * If the return value of this is not OK, the password
997 * should not be checked. If the return value is not Good,
998 * the password can be checked, but the user should not be
999 * able to set their password to this.
1001 * @param string $password Desired password
1002 * @param string $purpose one of 'login', 'create', 'reset'
1006 public function checkPasswordValidity( $password, $purpose = 'login' ) {
1007 global $wgPasswordPolicy;
1009 $upp = new UserPasswordPolicy(
1010 $wgPasswordPolicy['policies'],
1011 $wgPasswordPolicy['checks']
1014 $status = Status
::newGood();
1015 $result = false; // init $result to false for the internal checks
1017 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1018 $status->error( $result );
1022 if ( $result === false ) {
1023 $status->merge( $upp->checkUserPassword( $this, $password, $purpose ) );
1025 } elseif ( $result === true ) {
1028 $status->error( $result );
1029 return $status; // the isValidPassword hook set a string $result and returned true
1034 * Given unvalidated user input, return a canonical username, or false if
1035 * the username is invalid.
1036 * @param string $name User input
1037 * @param string|bool $validate Type of validation to use:
1038 * - false No validation
1039 * - 'valid' Valid for batch processes
1040 * - 'usable' Valid for batch processes and login
1041 * - 'creatable' Valid for batch processes, login and account creation
1043 * @throws InvalidArgumentException
1044 * @return bool|string
1046 public static function getCanonicalName( $name, $validate = 'valid' ) {
1047 // Force usernames to capital
1049 $name = $wgContLang->ucfirst( $name );
1051 # Reject names containing '#'; these will be cleaned up
1052 # with title normalisation, but then it's too late to
1054 if ( strpos( $name, '#' ) !== false ) {
1058 // Clean up name according to title rules,
1059 // but only when validation is requested (bug 12654)
1060 $t = ( $validate !== false ) ?
1061 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1062 // Check for invalid titles
1063 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1067 // Reject various classes of invalid names
1068 $name = AuthManager
::callLegacyAuthPlugin(
1069 'getCanonicalName', [ $t->getText() ], $t->getText()
1072 switch ( $validate ) {
1076 if ( !User
::isValidUserName( $name ) ) {
1081 if ( !User
::isUsableName( $name ) ) {
1086 if ( !User
::isCreatableName( $name ) ) {
1091 throw new InvalidArgumentException(
1092 'Invalid parameter value for $validate in ' . __METHOD__
);
1098 * Count the number of edits of a user
1100 * @param int $uid User ID to check
1101 * @return int The user's edit count
1103 * @deprecated since 1.21 in favour of User::getEditCount
1105 public static function edits( $uid ) {
1106 wfDeprecated( __METHOD__
, '1.21' );
1107 $user = self
::newFromId( $uid );
1108 return $user->getEditCount();
1112 * Return a random password.
1114 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1115 * @return string New random password
1117 public static function randomPassword() {
1118 global $wgMinimalPasswordLength;
1119 return PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1123 * Set cached properties to default.
1125 * @note This no longer clears uncached lazy-initialised properties;
1126 * the constructor does that instead.
1128 * @param string|bool $name
1130 public function loadDefaults( $name = false ) {
1132 $this->mName
= $name;
1133 $this->mRealName
= '';
1135 $this->mOptionOverrides
= null;
1136 $this->mOptionsLoaded
= false;
1138 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1139 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1140 if ( $loggedOut !== 0 ) {
1141 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1143 $this->mTouched
= '1'; # Allow any pages to be cached
1146 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1147 $this->mEmailAuthenticated
= null;
1148 $this->mEmailToken
= '';
1149 $this->mEmailTokenExpires
= null;
1150 $this->mRegistration
= wfTimestamp( TS_MW
);
1151 $this->mGroups
= [];
1153 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1157 * Return whether an item has been loaded.
1159 * @param string $item Item to check. Current possibilities:
1163 * @param string $all 'all' to check if the whole object has been loaded
1164 * or any other string to check if only the item is available (e.g.
1168 public function isItemLoaded( $item, $all = 'all' ) {
1169 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1170 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1174 * Set that an item has been loaded
1176 * @param string $item
1178 protected function setItemLoaded( $item ) {
1179 if ( is_array( $this->mLoadedItems
) ) {
1180 $this->mLoadedItems
[$item] = true;
1185 * Load user data from the session.
1187 * @return bool True if the user is logged in, false otherwise.
1189 private function loadFromSession() {
1192 Hooks
::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1193 if ( $result !== null ) {
1197 // MediaWiki\Session\Session already did the necessary authentication of the user
1198 // returned here, so just use it if applicable.
1199 $session = $this->getRequest()->getSession();
1200 $user = $session->getUser();
1201 if ( $user->isLoggedIn() ) {
1202 $this->loadFromUserObject( $user );
1203 // Other code expects these to be set in the session, so set them.
1204 $session->set( 'wsUserID', $this->getId() );
1205 $session->set( 'wsUserName', $this->getName() );
1206 $session->set( 'wsToken', $this->getToken() );
1214 * Load user and user_group data from the database.
1215 * $this->mId must be set, this is how the user is identified.
1217 * @param integer $flags User::READ_* constant bitfield
1218 * @return bool True if the user exists, false if the user is anonymous
1220 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1222 $this->mId
= intval( $this->mId
);
1224 if ( !$this->mId
) {
1225 // Anonymous users are not in the database
1226 $this->loadDefaults();
1230 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1231 $db = wfGetDB( $index );
1233 $s = $db->selectRow(
1235 self
::selectFields(),
1236 [ 'user_id' => $this->mId
],
1241 $this->queryFlagsUsed
= $flags;
1242 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1244 if ( $s !== false ) {
1245 // Initialise user table data
1246 $this->loadFromRow( $s );
1247 $this->mGroups
= null; // deferred
1248 $this->getEditCount(); // revalidation for nulls
1253 $this->loadDefaults();
1259 * Initialize this object from a row from the user table.
1261 * @param stdClass $row Row from the user table to load.
1262 * @param array $data Further user data to load into the object
1264 * user_groups Array with groups out of the user_groups table
1265 * user_properties Array with properties out of the user_properties table
1267 protected function loadFromRow( $row, $data = null ) {
1270 $this->mGroups
= null; // deferred
1272 if ( isset( $row->user_name
) ) {
1273 $this->mName
= $row->user_name
;
1274 $this->mFrom
= 'name';
1275 $this->setItemLoaded( 'name' );
1280 if ( isset( $row->user_real_name
) ) {
1281 $this->mRealName
= $row->user_real_name
;
1282 $this->setItemLoaded( 'realname' );
1287 if ( isset( $row->user_id
) ) {
1288 $this->mId
= intval( $row->user_id
);
1289 $this->mFrom
= 'id';
1290 $this->setItemLoaded( 'id' );
1295 if ( isset( $row->user_id
) && isset( $row->user_name
) ) {
1296 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1299 if ( isset( $row->user_editcount
) ) {
1300 $this->mEditCount
= $row->user_editcount
;
1305 if ( isset( $row->user_touched
) ) {
1306 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1311 if ( isset( $row->user_token
) ) {
1312 // The definition for the column is binary(32), so trim the NULs
1313 // that appends. The previous definition was char(32), so trim
1315 $this->mToken
= rtrim( $row->user_token
, " \0" );
1316 if ( $this->mToken
=== '' ) {
1317 $this->mToken
= null;
1323 if ( isset( $row->user_email
) ) {
1324 $this->mEmail
= $row->user_email
;
1325 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1326 $this->mEmailToken
= $row->user_email_token
;
1327 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1328 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1334 $this->mLoadedItems
= true;
1337 if ( is_array( $data ) ) {
1338 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1339 $this->mGroups
= $data['user_groups'];
1341 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1342 $this->loadOptions( $data['user_properties'] );
1348 * Load the data for this user object from another user object.
1352 protected function loadFromUserObject( $user ) {
1354 foreach ( self
::$mCacheVars as $var ) {
1355 $this->$var = $user->$var;
1360 * Load the groups from the database if they aren't already loaded.
1362 private function loadGroups() {
1363 if ( is_null( $this->mGroups
) ) {
1364 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1365 ?
wfGetDB( DB_MASTER
)
1366 : wfGetDB( DB_REPLICA
);
1367 $res = $db->select( 'user_groups',
1369 [ 'ug_user' => $this->mId
],
1371 $this->mGroups
= [];
1372 foreach ( $res as $row ) {
1373 $this->mGroups
[] = $row->ug_group
;
1379 * Add the user to the group if he/she meets given criteria.
1381 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1382 * possible to remove manually via Special:UserRights. In such case it
1383 * will not be re-added automatically. The user will also not lose the
1384 * group if they no longer meet the criteria.
1386 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1388 * @return array Array of groups the user has been promoted to.
1390 * @see $wgAutopromoteOnce
1392 public function addAutopromoteOnceGroups( $event ) {
1393 global $wgAutopromoteOnceLogInRC;
1395 if ( wfReadOnly() ||
!$this->getId() ) {
1399 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1400 if ( !count( $toPromote ) ) {
1404 if ( !$this->checkAndSetTouched() ) {
1405 return []; // raced out (bug T48834)
1408 $oldGroups = $this->getGroups(); // previous groups
1409 foreach ( $toPromote as $group ) {
1410 $this->addGroup( $group );
1412 // update groups in external authentication database
1413 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false ] );
1414 AuthManager
::callLegacyAuthPlugin( 'updateExternalDBGroups', [ $this, $toPromote ] );
1416 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1418 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1419 $logEntry->setPerformer( $this );
1420 $logEntry->setTarget( $this->getUserPage() );
1421 $logEntry->setParameters( [
1422 '4::oldgroups' => $oldGroups,
1423 '5::newgroups' => $newGroups,
1425 $logid = $logEntry->insert();
1426 if ( $wgAutopromoteOnceLogInRC ) {
1427 $logEntry->publish( $logid );
1434 * Builds update conditions. Additional conditions may be added to $conditions to
1435 * protected against race conditions using a compare-and-set (CAS) mechanism
1436 * based on comparing $this->mTouched with the user_touched field.
1438 * @param Database $db
1439 * @param array $conditions WHERE conditions for use with Database::update
1440 * @return array WHERE conditions for use with Database::update
1442 protected function makeUpdateConditions( Database
$db, array $conditions ) {
1443 if ( $this->mTouched
) {
1444 // CAS check: only update if the row wasn't changed sicne it was loaded.
1445 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1452 * Bump user_touched if it didn't change since this object was loaded
1454 * On success, the mTouched field is updated.
1455 * The user serialization cache is always cleared.
1457 * @return bool Whether user_touched was actually updated
1460 protected function checkAndSetTouched() {
1463 if ( !$this->mId
) {
1464 return false; // anon
1467 // Get a new user_touched that is higher than the old one
1468 $newTouched = $this->newTouchedTimestamp();
1470 $dbw = wfGetDB( DB_MASTER
);
1471 $dbw->update( 'user',
1472 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1473 $this->makeUpdateConditions( $dbw, [
1474 'user_id' => $this->mId
,
1478 $success = ( $dbw->affectedRows() > 0 );
1481 $this->mTouched
= $newTouched;
1482 $this->clearSharedCache();
1484 // Clears on failure too since that is desired if the cache is stale
1485 $this->clearSharedCache( 'refresh' );
1492 * Clear various cached data stored in this object. The cache of the user table
1493 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1495 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1496 * given source. May be "name", "id", "defaults", "session", or false for no reload.
1498 public function clearInstanceCache( $reloadFrom = false ) {
1499 $this->mNewtalk
= -1;
1500 $this->mDatePreference
= null;
1501 $this->mBlockedby
= -1; # Unset
1502 $this->mHash
= false;
1503 $this->mRights
= null;
1504 $this->mEffectiveGroups
= null;
1505 $this->mImplicitGroups
= null;
1506 $this->mGroups
= null;
1507 $this->mOptions
= null;
1508 $this->mOptionsLoaded
= false;
1509 $this->mEditCount
= null;
1511 if ( $reloadFrom ) {
1512 $this->mLoadedItems
= [];
1513 $this->mFrom
= $reloadFrom;
1518 * Combine the language default options with any site-specific options
1519 * and add the default language variants.
1521 * @return array Array of String options
1523 public static function getDefaultOptions() {
1524 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1526 static $defOpt = null;
1527 static $defOptLang = null;
1529 if ( $defOpt !== null && $defOptLang === $wgContLang->getCode() ) {
1530 // $wgContLang does not change (and should not change) mid-request,
1531 // but the unit tests change it anyway, and expect this method to
1532 // return values relevant to the current $wgContLang.
1536 $defOpt = $wgDefaultUserOptions;
1537 // Default language setting
1538 $defOptLang = $wgContLang->getCode();
1539 $defOpt['language'] = $defOptLang;
1540 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1541 $defOpt[$langCode == $wgContLang->getCode() ?
'variant' : "variant-$langCode"] = $langCode;
1544 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1545 // since extensions may change the set of searchable namespaces depending
1546 // on user groups/permissions.
1547 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1548 $defOpt['searchNs' . $nsnum] = (boolean
)$val;
1550 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1552 Hooks
::run( 'UserGetDefaultOptions', [ &$defOpt ] );
1558 * Get a given default option value.
1560 * @param string $opt Name of option to retrieve
1561 * @return string Default option value
1563 public static function getDefaultOption( $opt ) {
1564 $defOpts = self
::getDefaultOptions();
1565 if ( isset( $defOpts[$opt] ) ) {
1566 return $defOpts[$opt];
1573 * Get blocking information
1574 * @param bool $bFromSlave Whether to check the replica DB first.
1575 * To improve performance, non-critical checks are done against replica DBs.
1576 * Check when actually saving should be done against master.
1578 private function getBlockedStatus( $bFromSlave = true ) {
1579 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff;
1581 if ( -1 != $this->mBlockedby
) {
1585 wfDebug( __METHOD__
. ": checking...\n" );
1587 // Initialize data...
1588 // Otherwise something ends up stomping on $this->mBlockedby when
1589 // things get lazy-loaded later, causing false positive block hits
1590 // due to -1 !== 0. Probably session-related... Nothing should be
1591 // overwriting mBlockedby, surely?
1594 # We only need to worry about passing the IP address to the Block generator if the
1595 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1596 # know which IP address they're actually coming from
1598 if ( !$this->isAllowed( 'ipblock-exempt' ) ) {
1599 // $wgUser->getName() only works after the end of Setup.php. Until
1600 // then, assume it's a logged-out user.
1601 $globalUserName = $wgUser->isSafeToLoad()
1602 ?
$wgUser->getName()
1603 : IP
::sanitizeIP( $wgUser->getRequest()->getIP() );
1604 if ( $this->getName() === $globalUserName ) {
1605 $ip = $this->getRequest()->getIP();
1610 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1613 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1615 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1617 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1618 $block->mReason
= wfMessage( 'proxyblockreason' )->text();
1619 $block->setTarget( $ip );
1620 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1622 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1623 $block->mReason
= wfMessage( 'sorbsreason' )->text();
1624 $block->setTarget( $ip );
1628 // (bug 23343) Apply IP blocks to the contents of XFF headers, if enabled
1629 if ( !$block instanceof Block
1630 && $wgApplyIpBlocksToXff
1632 && !in_array( $ip, $wgProxyWhitelist )
1634 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1635 $xff = array_map( 'trim', explode( ',', $xff ) );
1636 $xff = array_diff( $xff, [ $ip ] );
1637 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1638 $block = Block
::chooseBlock( $xffblocks, $xff );
1639 if ( $block instanceof Block
) {
1640 # Mangle the reason to alert the user that the block
1641 # originated from matching the X-Forwarded-For header.
1642 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->text();
1646 if ( $block instanceof Block
) {
1647 wfDebug( __METHOD__
. ": Found block.\n" );
1648 $this->mBlock
= $block;
1649 $this->mBlockedby
= $block->getByName();
1650 $this->mBlockreason
= $block->mReason
;
1651 $this->mHideName
= $block->mHideName
;
1652 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1654 $this->mBlockedby
= '';
1655 $this->mHideName
= 0;
1656 $this->mAllowUsertalk
= false;
1660 Hooks
::run( 'GetBlockedStatus', [ &$this ] );
1665 * Whether the given IP is in a DNS blacklist.
1667 * @param string $ip IP to check
1668 * @param bool $checkWhitelist Whether to check the whitelist first
1669 * @return bool True if blacklisted.
1671 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1672 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1674 if ( !$wgEnableDnsBlacklist ) {
1678 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1682 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
1686 * Whether the given IP is in a given DNS blacklist.
1688 * @param string $ip IP to check
1689 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1690 * @return bool True if blacklisted.
1692 public function inDnsBlacklist( $ip, $bases ) {
1695 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1696 if ( IP
::isIPv4( $ip ) ) {
1697 // Reverse IP, bug 21255
1698 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1700 foreach ( (array)$bases as $base ) {
1702 // If we have an access key, use that too (ProjectHoneypot, etc.)
1704 if ( is_array( $base ) ) {
1705 if ( count( $base ) >= 2 ) {
1706 // Access key is 1, base URL is 0
1707 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1709 $host = "$ipReversed.{$base[0]}";
1711 $basename = $base[0];
1713 $host = "$ipReversed.$base";
1717 $ipList = gethostbynamel( $host );
1720 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
1724 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
1733 * Check if an IP address is in the local proxy list
1739 public static function isLocallyBlockedProxy( $ip ) {
1740 global $wgProxyList;
1742 if ( !$wgProxyList ) {
1746 if ( !is_array( $wgProxyList ) ) {
1747 // Load from the specified file
1748 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1751 if ( !is_array( $wgProxyList ) ) {
1753 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1755 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1756 // Old-style flipped proxy list
1765 * Is this user subject to rate limiting?
1767 * @return bool True if rate limited
1769 public function isPingLimitable() {
1770 global $wgRateLimitsExcludedIPs;
1771 if ( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1772 // No other good way currently to disable rate limits
1773 // for specific IPs. :P
1774 // But this is a crappy hack and should die.
1777 return !$this->isAllowed( 'noratelimit' );
1781 * Primitive rate limits: enforce maximum actions per time period
1782 * to put a brake on flooding.
1784 * The method generates both a generic profiling point and a per action one
1785 * (suffix being "-$action".
1787 * @note When using a shared cache like memcached, IP-address
1788 * last-hit counters will be shared across wikis.
1790 * @param string $action Action to enforce; 'edit' if unspecified
1791 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1792 * @return bool True if a rate limiter was tripped
1794 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1795 // Call the 'PingLimiter' hook
1797 if ( !Hooks
::run( 'PingLimiter', [ &$this, $action, &$result, $incrBy ] ) ) {
1801 global $wgRateLimits;
1802 if ( !isset( $wgRateLimits[$action] ) ) {
1806 $limits = array_merge(
1807 [ '&can-bypass' => true ],
1808 $wgRateLimits[$action]
1811 // Some groups shouldn't trigger the ping limiter, ever
1812 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
1817 $id = $this->getId();
1819 $isNewbie = $this->isNewbie();
1823 if ( isset( $limits['anon'] ) ) {
1824 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1827 // limits for logged-in users
1828 if ( isset( $limits['user'] ) ) {
1829 $userLimit = $limits['user'];
1831 // limits for newbie logged-in users
1832 if ( $isNewbie && isset( $limits['newbie'] ) ) {
1833 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1837 // limits for anons and for newbie logged-in users
1840 if ( isset( $limits['ip'] ) ) {
1841 $ip = $this->getRequest()->getIP();
1842 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1844 // subnet-based limits
1845 if ( isset( $limits['subnet'] ) ) {
1846 $ip = $this->getRequest()->getIP();
1847 $subnet = IP
::getSubnet( $ip );
1848 if ( $subnet !== false ) {
1849 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1854 // Check for group-specific permissions
1855 // If more than one group applies, use the group with the highest limit ratio (max/period)
1856 foreach ( $this->getGroups() as $group ) {
1857 if ( isset( $limits[$group] ) ) {
1858 if ( $userLimit === false
1859 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
1861 $userLimit = $limits[$group];
1866 // Set the user limit key
1867 if ( $userLimit !== false ) {
1868 list( $max, $period ) = $userLimit;
1869 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
1870 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $userLimit;
1873 // ip-based limits for all ping-limitable users
1874 if ( isset( $limits['ip-all'] ) ) {
1875 $ip = $this->getRequest()->getIP();
1876 // ignore if user limit is more permissive
1877 if ( $isNewbie ||
$userLimit === false
1878 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
1879 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
1883 // subnet-based limits for all ping-limitable users
1884 if ( isset( $limits['subnet-all'] ) ) {
1885 $ip = $this->getRequest()->getIP();
1886 $subnet = IP
::getSubnet( $ip );
1887 if ( $subnet !== false ) {
1888 // ignore if user limit is more permissive
1889 if ( $isNewbie ||
$userLimit === false
1890 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
1891 > $userLimit[0] / $userLimit[1] ) {
1892 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
1897 $cache = ObjectCache
::getLocalClusterInstance();
1900 foreach ( $keys as $key => $limit ) {
1901 list( $max, $period ) = $limit;
1902 $summary = "(limit $max in {$period}s)";
1903 $count = $cache->get( $key );
1906 if ( $count >= $max ) {
1907 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
1908 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
1911 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1914 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1915 if ( $incrBy > 0 ) {
1916 $cache->add( $key, 0, intval( $period ) ); // first ping
1919 if ( $incrBy > 0 ) {
1920 $cache->incr( $key, $incrBy );
1928 * Check if user is blocked
1930 * @param bool $bFromSlave Whether to check the replica DB instead of
1931 * the master. Hacked from false due to horrible probs on site.
1932 * @return bool True if blocked, false otherwise
1934 public function isBlocked( $bFromSlave = true ) {
1935 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1939 * Get the block affecting the user, or null if the user is not blocked
1941 * @param bool $bFromSlave Whether to check the replica DB instead of the master
1942 * @return Block|null
1944 public function getBlock( $bFromSlave = true ) {
1945 $this->getBlockedStatus( $bFromSlave );
1946 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1950 * Check if user is blocked from editing a particular article
1952 * @param Title $title Title to check
1953 * @param bool $bFromSlave Whether to check the replica DB instead of the master
1956 public function isBlockedFrom( $title, $bFromSlave = false ) {
1957 global $wgBlockAllowsUTEdit;
1959 $blocked = $this->isBlocked( $bFromSlave );
1960 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1961 // If a user's name is suppressed, they cannot make edits anywhere
1962 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName()
1963 && $title->getNamespace() == NS_USER_TALK
) {
1965 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1968 Hooks
::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
1974 * If user is blocked, return the name of the user who placed the block
1975 * @return string Name of blocker
1977 public function blockedBy() {
1978 $this->getBlockedStatus();
1979 return $this->mBlockedby
;
1983 * If user is blocked, return the specified reason for the block
1984 * @return string Blocking reason
1986 public function blockedFor() {
1987 $this->getBlockedStatus();
1988 return $this->mBlockreason
;
1992 * If user is blocked, return the ID for the block
1993 * @return int Block ID
1995 public function getBlockId() {
1996 $this->getBlockedStatus();
1997 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2001 * Check if user is blocked on all wikis.
2002 * Do not use for actual edit permission checks!
2003 * This is intended for quick UI checks.
2005 * @param string $ip IP address, uses current client if none given
2006 * @return bool True if blocked, false otherwise
2008 public function isBlockedGlobally( $ip = '' ) {
2009 return $this->getGlobalBlock( $ip ) instanceof Block
;
2013 * Check if user is blocked on all wikis.
2014 * Do not use for actual edit permission checks!
2015 * This is intended for quick UI checks.
2017 * @param string $ip IP address, uses current client if none given
2018 * @return Block|null Block object if blocked, null otherwise
2019 * @throws FatalError
2020 * @throws MWException
2022 public function getGlobalBlock( $ip = '' ) {
2023 if ( $this->mGlobalBlock
!== null ) {
2024 return $this->mGlobalBlock ?
: null;
2026 // User is already an IP?
2027 if ( IP
::isIPAddress( $this->getName() ) ) {
2028 $ip = $this->getName();
2030 $ip = $this->getRequest()->getIP();
2034 Hooks
::run( 'UserIsBlockedGlobally', [ &$this, $ip, &$blocked, &$block ] );
2036 if ( $blocked && $block === null ) {
2037 // back-compat: UserIsBlockedGlobally didn't have $block param first
2039 $block->setTarget( $ip );
2042 $this->mGlobalBlock
= $blocked ?
$block : false;
2043 return $this->mGlobalBlock ?
: null;
2047 * Check if user account is locked
2049 * @return bool True if locked, false otherwise
2051 public function isLocked() {
2052 if ( $this->mLocked
!== null ) {
2053 return $this->mLocked
;
2055 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$this ], null );
2056 $this->mLocked
= $authUser && $authUser->isLocked();
2057 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2058 return $this->mLocked
;
2062 * Check if user account is hidden
2064 * @return bool True if hidden, false otherwise
2066 public function isHidden() {
2067 if ( $this->mHideName
!== null ) {
2068 return $this->mHideName
;
2070 $this->getBlockedStatus();
2071 if ( !$this->mHideName
) {
2072 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$this ], null );
2073 $this->mHideName
= $authUser && $authUser->isHidden();
2074 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2076 return $this->mHideName
;
2080 * Get the user's ID.
2081 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2083 public function getId() {
2084 if ( $this->mId
=== null && $this->mName
!== null && User
::isIP( $this->mName
) ) {
2085 // Special case, we know the user is anonymous
2087 } elseif ( !$this->isItemLoaded( 'id' ) ) {
2088 // Don't load if this was initialized from an ID
2092 return (int)$this->mId
;
2096 * Set the user and reload all fields according to a given ID
2097 * @param int $v User ID to reload
2099 public function setId( $v ) {
2101 $this->clearInstanceCache( 'id' );
2105 * Get the user name, or the IP of an anonymous user
2106 * @return string User's name or IP address
2108 public function getName() {
2109 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2110 // Special case optimisation
2111 return $this->mName
;
2114 if ( $this->mName
=== false ) {
2116 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2118 return $this->mName
;
2123 * Set the user name.
2125 * This does not reload fields from the database according to the given
2126 * name. Rather, it is used to create a temporary "nonexistent user" for
2127 * later addition to the database. It can also be used to set the IP
2128 * address for an anonymous user to something other than the current
2131 * @note User::newFromName() has roughly the same function, when the named user
2133 * @param string $str New user name to set
2135 public function setName( $str ) {
2137 $this->mName
= $str;
2141 * Get the user's name escaped by underscores.
2142 * @return string Username escaped by underscores.
2144 public function getTitleKey() {
2145 return str_replace( ' ', '_', $this->getName() );
2149 * Check if the user has new messages.
2150 * @return bool True if the user has new messages
2152 public function getNewtalk() {
2155 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2156 if ( $this->mNewtalk
=== -1 ) {
2157 $this->mNewtalk
= false; # reset talk page status
2159 // Check memcached separately for anons, who have no
2160 // entire User object stored in there.
2161 if ( !$this->mId
) {
2162 global $wgDisableAnonTalk;
2163 if ( $wgDisableAnonTalk ) {
2164 // Anon newtalk disabled by configuration.
2165 $this->mNewtalk
= false;
2167 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2170 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2174 return (bool)$this->mNewtalk
;
2178 * Return the data needed to construct links for new talk page message
2179 * alerts. If there are new messages, this will return an associative array
2180 * with the following data:
2181 * wiki: The database name of the wiki
2182 * link: Root-relative link to the user's talk page
2183 * rev: The last talk page revision that the user has seen or null. This
2184 * is useful for building diff links.
2185 * If there are no new messages, it returns an empty array.
2186 * @note This function was designed to accomodate multiple talk pages, but
2187 * currently only returns a single link and revision.
2190 public function getNewMessageLinks() {
2192 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$this, &$talks ] ) ) {
2194 } elseif ( !$this->getNewtalk() ) {
2197 $utp = $this->getTalkPage();
2198 $dbr = wfGetDB( DB_REPLICA
);
2199 // Get the "last viewed rev" timestamp from the oldest message notification
2200 $timestamp = $dbr->selectField( 'user_newtalk',
2201 'MIN(user_last_timestamp)',
2202 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2204 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2205 return [ [ 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ] ];
2209 * Get the revision ID for the last talk page revision viewed by the talk
2211 * @return int|null Revision ID or null
2213 public function getNewMessageRevisionId() {
2214 $newMessageRevisionId = null;
2215 $newMessageLinks = $this->getNewMessageLinks();
2216 if ( $newMessageLinks ) {
2217 // Note: getNewMessageLinks() never returns more than a single link
2218 // and it is always for the same wiki, but we double-check here in
2219 // case that changes some time in the future.
2220 if ( count( $newMessageLinks ) === 1
2221 && $newMessageLinks[0]['wiki'] === wfWikiID()
2222 && $newMessageLinks[0]['rev']
2224 /** @var Revision $newMessageRevision */
2225 $newMessageRevision = $newMessageLinks[0]['rev'];
2226 $newMessageRevisionId = $newMessageRevision->getId();
2229 return $newMessageRevisionId;
2233 * Internal uncached check for new messages
2236 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2237 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2238 * @return bool True if the user has new messages
2240 protected function checkNewtalk( $field, $id ) {
2241 $dbr = wfGetDB( DB_REPLICA
);
2243 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2245 return $ok !== false;
2249 * Add or update the new messages flag
2250 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2251 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2252 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2253 * @return bool True if successful, false otherwise
2255 protected function updateNewtalk( $field, $id, $curRev = null ) {
2256 // Get timestamp of the talk page revision prior to the current one
2257 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2258 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2259 // Mark the user as having new messages since this revision
2260 $dbw = wfGetDB( DB_MASTER
);
2261 $dbw->insert( 'user_newtalk',
2262 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2265 if ( $dbw->affectedRows() ) {
2266 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2269 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2275 * Clear the new messages flag for the given user
2276 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2277 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2278 * @return bool True if successful, false otherwise
2280 protected function deleteNewtalk( $field, $id ) {
2281 $dbw = wfGetDB( DB_MASTER
);
2282 $dbw->delete( 'user_newtalk',
2285 if ( $dbw->affectedRows() ) {
2286 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2289 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2295 * Update the 'You have new messages!' status.
2296 * @param bool $val Whether the user has new messages
2297 * @param Revision $curRev New, as yet unseen revision of the user talk
2298 * page. Ignored if null or !$val.
2300 public function setNewtalk( $val, $curRev = null ) {
2301 if ( wfReadOnly() ) {
2306 $this->mNewtalk
= $val;
2308 if ( $this->isAnon() ) {
2310 $id = $this->getName();
2313 $id = $this->getId();
2317 $changed = $this->updateNewtalk( $field, $id, $curRev );
2319 $changed = $this->deleteNewtalk( $field, $id );
2323 $this->invalidateCache();
2328 * Generate a current or new-future timestamp to be stored in the
2329 * user_touched field when we update things.
2330 * @return string Timestamp in TS_MW format
2332 private function newTouchedTimestamp() {
2333 global $wgClockSkewFudge;
2335 $time = wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2336 if ( $this->mTouched
&& $time <= $this->mTouched
) {
2337 $time = wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2344 * Clear user data from memcached
2346 * Use after applying updates to the database; caller's
2347 * responsibility to update user_touched if appropriate.
2349 * Called implicitly from invalidateCache() and saveSettings().
2351 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2353 public function clearSharedCache( $mode = 'changed' ) {
2354 if ( !$this->getId() ) {
2358 $cache = ObjectCache
::getMainWANInstance();
2359 $key = $this->getCacheKey( $cache );
2360 if ( $mode === 'refresh' ) {
2361 $cache->delete( $key, 1 );
2363 wfGetDB( DB_MASTER
)->onTransactionPreCommitOrIdle(
2364 function() use ( $cache, $key ) {
2365 $cache->delete( $key );
2373 * Immediately touch the user data cache for this account
2375 * Calls touch() and removes account data from memcached
2377 public function invalidateCache() {
2379 $this->clearSharedCache();
2383 * Update the "touched" timestamp for the user
2385 * This is useful on various login/logout events when making sure that
2386 * a browser or proxy that has multiple tenants does not suffer cache
2387 * pollution where the new user sees the old users content. The value
2388 * of getTouched() is checked when determining 304 vs 200 responses.
2389 * Unlike invalidateCache(), this preserves the User object cache and
2390 * avoids database writes.
2394 public function touch() {
2395 $id = $this->getId();
2397 $key = wfMemcKey( 'user-quicktouched', 'id', $id );
2398 ObjectCache
::getMainWANInstance()->touchCheckKey( $key );
2399 $this->mQuickTouched
= null;
2404 * Validate the cache for this account.
2405 * @param string $timestamp A timestamp in TS_MW format
2408 public function validateCache( $timestamp ) {
2409 return ( $timestamp >= $this->getTouched() );
2413 * Get the user touched timestamp
2415 * Use this value only to validate caches via inequalities
2416 * such as in the case of HTTP If-Modified-Since response logic
2418 * @return string TS_MW Timestamp
2420 public function getTouched() {
2424 if ( $this->mQuickTouched
=== null ) {
2425 $key = wfMemcKey( 'user-quicktouched', 'id', $this->mId
);
2426 $cache = ObjectCache
::getMainWANInstance();
2428 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2431 return max( $this->mTouched
, $this->mQuickTouched
);
2434 return $this->mTouched
;
2438 * Get the user_touched timestamp field (time of last DB updates)
2439 * @return string TS_MW Timestamp
2442 public function getDBTouched() {
2445 return $this->mTouched
;
2449 * @deprecated Removed in 1.27.
2453 public function getPassword() {
2454 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2458 * @deprecated Removed in 1.27.
2462 public function getTemporaryPassword() {
2463 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2467 * Set the password and reset the random token.
2468 * Calls through to authentication plugin if necessary;
2469 * will have no effect if the auth plugin refuses to
2470 * pass the change through or if the legal password
2473 * As a special case, setting the password to null
2474 * wipes it, so the account cannot be logged in until
2475 * a new password is set, for instance via e-mail.
2477 * @deprecated since 1.27, use AuthManager instead
2478 * @param string $str New password to set
2479 * @throws PasswordError On failure
2482 public function setPassword( $str ) {
2483 return $this->setPasswordInternal( $str );
2487 * Set the password and reset the random token unconditionally.
2489 * @deprecated since 1.27, use AuthManager instead
2490 * @param string|null $str New password to set or null to set an invalid
2491 * password hash meaning that the user will not be able to log in
2492 * through the web interface.
2494 public function setInternalPassword( $str ) {
2495 $this->setPasswordInternal( $str );
2499 * Actually set the password and such
2500 * @since 1.27 cannot set a password for a user not in the database
2501 * @param string|null $str New password to set or null to set an invalid
2502 * password hash meaning that the user will not be able to log in
2503 * through the web interface.
2504 * @return bool Success
2506 private function setPasswordInternal( $str ) {
2507 $manager = AuthManager
::singleton();
2509 // If the user doesn't exist yet, fail
2510 if ( !$manager->userExists( $this->getName() ) ) {
2511 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2514 $status = $this->changeAuthenticationData( [
2515 'username' => $this->getName(),
2519 if ( !$status->isGood() ) {
2520 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2521 ->info( __METHOD__
. ': Password change rejected: '
2522 . $status->getWikiText( null, null, 'en' ) );
2526 $this->setOption( 'watchlisttoken', false );
2527 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2533 * Changes credentials of the user.
2535 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2536 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2537 * e.g. when no provider handled the change.
2539 * @param array $data A set of authentication data in fieldname => value format. This is the
2540 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2544 public function changeAuthenticationData( array $data ) {
2545 $manager = AuthManager
::singleton();
2546 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2547 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2549 $status = Status
::newGood( 'ignored' );
2550 foreach ( $reqs as $req ) {
2551 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2553 if ( $status->getValue() === 'ignored' ) {
2554 $status->warning( 'authenticationdatachange-ignored' );
2557 if ( $status->isGood() ) {
2558 foreach ( $reqs as $req ) {
2559 $manager->changeAuthenticationData( $req );
2566 * Get the user's current token.
2567 * @param bool $forceCreation Force the generation of a new token if the
2568 * user doesn't have one (default=true for backwards compatibility).
2569 * @return string|null Token
2571 public function getToken( $forceCreation = true ) {
2572 global $wgAuthenticationTokenVersion;
2575 if ( !$this->mToken
&& $forceCreation ) {
2579 if ( !$this->mToken
) {
2580 // The user doesn't have a token, return null to indicate that.
2582 } elseif ( $this->mToken
=== self
::INVALID_TOKEN
) {
2583 // We return a random value here so existing token checks are very
2585 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2586 } elseif ( $wgAuthenticationTokenVersion === null ) {
2587 // $wgAuthenticationTokenVersion not in use, so return the raw secret
2588 return $this->mToken
;
2590 // $wgAuthenticationTokenVersion in use, so hmac it.
2591 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
2593 // The raw hash can be overly long. Shorten it up.
2594 $len = max( 32, self
::TOKEN_LENGTH
);
2595 if ( strlen( $ret ) < $len ) {
2596 // Should never happen, even md5 is 128 bits
2597 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
2599 return substr( $ret, -$len );
2604 * Set the random token (used for persistent authentication)
2605 * Called from loadDefaults() among other places.
2607 * @param string|bool $token If specified, set the token to this value
2609 public function setToken( $token = false ) {
2611 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
2612 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
2613 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
2614 } elseif ( !$token ) {
2615 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2617 $this->mToken
= $token;
2622 * Set the password for a password reminder or new account email
2624 * @deprecated Removed in 1.27. Use PasswordReset instead.
2625 * @param string $str New password to set or null to set an invalid
2626 * password hash meaning that the user will not be able to use it
2627 * @param bool $throttle If true, reset the throttle timestamp to the present
2629 public function setNewpassword( $str, $throttle = true ) {
2630 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2634 * Has password reminder email been sent within the last
2635 * $wgPasswordReminderResendTime hours?
2636 * @deprecated Removed in 1.27. See above.
2639 public function isPasswordReminderThrottled() {
2640 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2644 * Get the user's e-mail address
2645 * @return string User's email address
2647 public function getEmail() {
2649 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
2650 return $this->mEmail
;
2654 * Get the timestamp of the user's e-mail authentication
2655 * @return string TS_MW timestamp
2657 public function getEmailAuthenticationTimestamp() {
2659 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
2660 return $this->mEmailAuthenticated
;
2664 * Set the user's e-mail address
2665 * @param string $str New e-mail address
2667 public function setEmail( $str ) {
2669 if ( $str == $this->mEmail
) {
2672 $this->invalidateEmail();
2673 $this->mEmail
= $str;
2674 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
2678 * Set the user's e-mail address and a confirmation mail if needed.
2681 * @param string $str New e-mail address
2684 public function setEmailWithConfirmation( $str ) {
2685 global $wgEnableEmail, $wgEmailAuthentication;
2687 if ( !$wgEnableEmail ) {
2688 return Status
::newFatal( 'emaildisabled' );
2691 $oldaddr = $this->getEmail();
2692 if ( $str === $oldaddr ) {
2693 return Status
::newGood( true );
2696 $type = $oldaddr != '' ?
'changed' : 'set';
2697 $notificationResult = null;
2699 if ( $wgEmailAuthentication ) {
2700 // Send the user an email notifying the user of the change in registered
2701 // email address on their previous email address
2702 if ( $type == 'changed' ) {
2703 $change = $str != '' ?
'changed' : 'removed';
2704 $notificationResult = $this->sendMail(
2705 wfMessage( 'notificationemail_subject_' . $change )->text(),
2706 wfMessage( 'notificationemail_body_' . $change,
2707 $this->getRequest()->getIP(),
2714 $this->setEmail( $str );
2716 if ( $str !== '' && $wgEmailAuthentication ) {
2717 // Send a confirmation request to the new address if needed
2718 $result = $this->sendConfirmationMail( $type );
2720 if ( $notificationResult !== null ) {
2721 $result->merge( $notificationResult );
2724 if ( $result->isGood() ) {
2725 // Say to the caller that a confirmation and notification mail has been sent
2726 $result->value
= 'eauth';
2729 $result = Status
::newGood( true );
2736 * Get the user's real name
2737 * @return string User's real name
2739 public function getRealName() {
2740 if ( !$this->isItemLoaded( 'realname' ) ) {
2744 return $this->mRealName
;
2748 * Set the user's real name
2749 * @param string $str New real name
2751 public function setRealName( $str ) {
2753 $this->mRealName
= $str;
2757 * Get the user's current setting for a given option.
2759 * @param string $oname The option to check
2760 * @param string $defaultOverride A default value returned if the option does not exist
2761 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2762 * @return string User's current value for the option
2763 * @see getBoolOption()
2764 * @see getIntOption()
2766 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2767 global $wgHiddenPrefs;
2768 $this->loadOptions();
2770 # We want 'disabled' preferences to always behave as the default value for
2771 # users, even if they have set the option explicitly in their settings (ie they
2772 # set it, and then it was disabled removing their ability to change it). But
2773 # we don't want to erase the preferences in the database in case the preference
2774 # is re-enabled again. So don't touch $mOptions, just override the returned value
2775 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2776 return self
::getDefaultOption( $oname );
2779 if ( array_key_exists( $oname, $this->mOptions
) ) {
2780 return $this->mOptions
[$oname];
2782 return $defaultOverride;
2787 * Get all user's options
2789 * @param int $flags Bitwise combination of:
2790 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
2791 * to the default value. (Since 1.25)
2794 public function getOptions( $flags = 0 ) {
2795 global $wgHiddenPrefs;
2796 $this->loadOptions();
2797 $options = $this->mOptions
;
2799 # We want 'disabled' preferences to always behave as the default value for
2800 # users, even if they have set the option explicitly in their settings (ie they
2801 # set it, and then it was disabled removing their ability to change it). But
2802 # we don't want to erase the preferences in the database in case the preference
2803 # is re-enabled again. So don't touch $mOptions, just override the returned value
2804 foreach ( $wgHiddenPrefs as $pref ) {
2805 $default = self
::getDefaultOption( $pref );
2806 if ( $default !== null ) {
2807 $options[$pref] = $default;
2811 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
2812 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
2819 * Get the user's current setting for a given option, as a boolean value.
2821 * @param string $oname The option to check
2822 * @return bool User's current value for the option
2825 public function getBoolOption( $oname ) {
2826 return (bool)$this->getOption( $oname );
2830 * Get the user's current setting for a given option, as an integer value.
2832 * @param string $oname The option to check
2833 * @param int $defaultOverride A default value returned if the option does not exist
2834 * @return int User's current value for the option
2837 public function getIntOption( $oname, $defaultOverride = 0 ) {
2838 $val = $this->getOption( $oname );
2840 $val = $defaultOverride;
2842 return intval( $val );
2846 * Set the given option for a user.
2848 * You need to call saveSettings() to actually write to the database.
2850 * @param string $oname The option to set
2851 * @param mixed $val New value to set
2853 public function setOption( $oname, $val ) {
2854 $this->loadOptions();
2856 // Explicitly NULL values should refer to defaults
2857 if ( is_null( $val ) ) {
2858 $val = self
::getDefaultOption( $oname );
2861 $this->mOptions
[$oname] = $val;
2865 * Get a token stored in the preferences (like the watchlist one),
2866 * resetting it if it's empty (and saving changes).
2868 * @param string $oname The option name to retrieve the token from
2869 * @return string|bool User's current value for the option, or false if this option is disabled.
2870 * @see resetTokenFromOption()
2872 * @deprecated since 1.26 Applications should use the OAuth extension
2874 public function getTokenFromOption( $oname ) {
2875 global $wgHiddenPrefs;
2877 $id = $this->getId();
2878 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
2882 $token = $this->getOption( $oname );
2884 // Default to a value based on the user token to avoid space
2885 // wasted on storing tokens for all users. When this option
2886 // is set manually by the user, only then is it stored.
2887 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
2894 * Reset a token stored in the preferences (like the watchlist one).
2895 * *Does not* save user's preferences (similarly to setOption()).
2897 * @param string $oname The option name to reset the token in
2898 * @return string|bool New token value, or false if this option is disabled.
2899 * @see getTokenFromOption()
2902 public function resetTokenFromOption( $oname ) {
2903 global $wgHiddenPrefs;
2904 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2908 $token = MWCryptRand
::generateHex( 40 );
2909 $this->setOption( $oname, $token );
2914 * Return a list of the types of user options currently returned by
2915 * User::getOptionKinds().
2917 * Currently, the option kinds are:
2918 * - 'registered' - preferences which are registered in core MediaWiki or
2919 * by extensions using the UserGetDefaultOptions hook.
2920 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2921 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
2922 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2923 * be used by user scripts.
2924 * - 'special' - "preferences" that are not accessible via User::getOptions
2925 * or User::setOptions.
2926 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2927 * These are usually legacy options, removed in newer versions.
2929 * The API (and possibly others) use this function to determine the possible
2930 * option types for validation purposes, so make sure to update this when a
2931 * new option kind is added.
2933 * @see User::getOptionKinds
2934 * @return array Option kinds
2936 public static function listOptionKinds() {
2939 'registered-multiselect',
2940 'registered-checkmatrix',
2948 * Return an associative array mapping preferences keys to the kind of a preference they're
2949 * used for. Different kinds are handled differently when setting or reading preferences.
2951 * See User::listOptionKinds for the list of valid option types that can be provided.
2953 * @see User::listOptionKinds
2954 * @param IContextSource $context
2955 * @param array $options Assoc. array with options keys to check as keys.
2956 * Defaults to $this->mOptions.
2957 * @return array The key => kind mapping data
2959 public function getOptionKinds( IContextSource
$context, $options = null ) {
2960 $this->loadOptions();
2961 if ( $options === null ) {
2962 $options = $this->mOptions
;
2965 $prefs = Preferences
::getPreferences( $this, $context );
2968 // Pull out the "special" options, so they don't get converted as
2969 // multiselect or checkmatrix.
2970 $specialOptions = array_fill_keys( Preferences
::getSaveBlacklist(), true );
2971 foreach ( $specialOptions as $name => $value ) {
2972 unset( $prefs[$name] );
2975 // Multiselect and checkmatrix options are stored in the database with
2976 // one key per option, each having a boolean value. Extract those keys.
2977 $multiselectOptions = [];
2978 foreach ( $prefs as $name => $info ) {
2979 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
2980 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
2981 $opts = HTMLFormField
::flattenOptions( $info['options'] );
2982 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2984 foreach ( $opts as $value ) {
2985 $multiselectOptions["$prefix$value"] = true;
2988 unset( $prefs[$name] );
2991 $checkmatrixOptions = [];
2992 foreach ( $prefs as $name => $info ) {
2993 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
2994 ( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
2995 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
2996 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
2997 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2999 foreach ( $columns as $column ) {
3000 foreach ( $rows as $row ) {
3001 $checkmatrixOptions["$prefix$column-$row"] = true;
3005 unset( $prefs[$name] );
3009 // $value is ignored
3010 foreach ( $options as $key => $value ) {
3011 if ( isset( $prefs[$key] ) ) {
3012 $mapping[$key] = 'registered';
3013 } elseif ( isset( $multiselectOptions[$key] ) ) {
3014 $mapping[$key] = 'registered-multiselect';
3015 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3016 $mapping[$key] = 'registered-checkmatrix';
3017 } elseif ( isset( $specialOptions[$key] ) ) {
3018 $mapping[$key] = 'special';
3019 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3020 $mapping[$key] = 'userjs';
3022 $mapping[$key] = 'unused';
3030 * Reset certain (or all) options to the site defaults
3032 * The optional parameter determines which kinds of preferences will be reset.
3033 * Supported values are everything that can be reported by getOptionKinds()
3034 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3036 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3037 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3038 * for backwards-compatibility.
3039 * @param IContextSource|null $context Context source used when $resetKinds
3040 * does not contain 'all', passed to getOptionKinds().
3041 * Defaults to RequestContext::getMain() when null.
3043 public function resetOptions(
3044 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3045 IContextSource
$context = null
3048 $defaultOptions = self
::getDefaultOptions();
3050 if ( !is_array( $resetKinds ) ) {
3051 $resetKinds = [ $resetKinds ];
3054 if ( in_array( 'all', $resetKinds ) ) {
3055 $newOptions = $defaultOptions;
3057 if ( $context === null ) {
3058 $context = RequestContext
::getMain();
3061 $optionKinds = $this->getOptionKinds( $context );
3062 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3065 // Use default values for the options that should be deleted, and
3066 // copy old values for the ones that shouldn't.
3067 foreach ( $this->mOptions
as $key => $value ) {
3068 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3069 if ( array_key_exists( $key, $defaultOptions ) ) {
3070 $newOptions[$key] = $defaultOptions[$key];
3073 $newOptions[$key] = $value;
3078 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3080 $this->mOptions
= $newOptions;
3081 $this->mOptionsLoaded
= true;
3085 * Get the user's preferred date format.
3086 * @return string User's preferred date format
3088 public function getDatePreference() {
3089 // Important migration for old data rows
3090 if ( is_null( $this->mDatePreference
) ) {
3092 $value = $this->getOption( 'date' );
3093 $map = $wgLang->getDatePreferenceMigrationMap();
3094 if ( isset( $map[$value] ) ) {
3095 $value = $map[$value];
3097 $this->mDatePreference
= $value;
3099 return $this->mDatePreference
;
3103 * Determine based on the wiki configuration and the user's options,
3104 * whether this user must be over HTTPS no matter what.
3108 public function requiresHTTPS() {
3109 global $wgSecureLogin;
3110 if ( !$wgSecureLogin ) {
3113 $https = $this->getBoolOption( 'prefershttps' );
3114 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3116 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3123 * Get the user preferred stub threshold
3127 public function getStubThreshold() {
3128 global $wgMaxArticleSize; # Maximum article size, in Kb
3129 $threshold = $this->getIntOption( 'stubthreshold' );
3130 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3131 // If they have set an impossible value, disable the preference
3132 // so we can use the parser cache again.
3139 * Get the permissions this user has.
3140 * @return array Array of String permission names
3142 public function getRights() {
3143 if ( is_null( $this->mRights
) ) {
3144 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3145 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3147 // Deny any rights denied by the user's session, unless this
3148 // endpoint has no sessions.
3149 if ( !defined( 'MW_NO_SESSION' ) ) {
3150 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3151 if ( $allowedRights !== null ) {
3152 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3156 // Force reindexation of rights when a hook has unset one of them
3157 $this->mRights
= array_values( array_unique( $this->mRights
) );
3159 // If block disables login, we should also remove any
3160 // extra rights blocked users might have, in case the
3161 // blocked user has a pre-existing session (T129738).
3162 // This is checked here for cases where people only call
3163 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3164 // to give a better error message in the common case.
3165 $config = RequestContext
::getMain()->getConfig();
3167 $this->isLoggedIn() &&
3168 $config->get( 'BlockDisablesLogin' ) &&
3172 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3175 return $this->mRights
;
3179 * Get the list of explicit group memberships this user has.
3180 * The implicit * and user groups are not included.
3181 * @return array Array of String internal group names
3183 public function getGroups() {
3185 $this->loadGroups();
3186 return $this->mGroups
;
3190 * Get the list of implicit group memberships this user has.
3191 * This includes all explicit groups, plus 'user' if logged in,
3192 * '*' for all accounts, and autopromoted groups
3193 * @param bool $recache Whether to avoid the cache
3194 * @return array Array of String internal group names
3196 public function getEffectiveGroups( $recache = false ) {
3197 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3198 $this->mEffectiveGroups
= array_unique( array_merge(
3199 $this->getGroups(), // explicit groups
3200 $this->getAutomaticGroups( $recache ) // implicit groups
3202 // Hook for additional groups
3203 Hooks
::run( 'UserEffectiveGroups', [ &$this, &$this->mEffectiveGroups
] );
3204 // Force reindexation of groups when a hook has unset one of them
3205 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3207 return $this->mEffectiveGroups
;
3211 * Get the list of implicit group memberships this user has.
3212 * This includes 'user' if logged in, '*' for all accounts,
3213 * and autopromoted groups
3214 * @param bool $recache Whether to avoid the cache
3215 * @return array Array of String internal group names
3217 public function getAutomaticGroups( $recache = false ) {
3218 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3219 $this->mImplicitGroups
= [ '*' ];
3220 if ( $this->getId() ) {
3221 $this->mImplicitGroups
[] = 'user';
3223 $this->mImplicitGroups
= array_unique( array_merge(
3224 $this->mImplicitGroups
,
3225 Autopromote
::getAutopromoteGroups( $this )
3229 // Assure data consistency with rights/groups,
3230 // as getEffectiveGroups() depends on this function
3231 $this->mEffectiveGroups
= null;
3234 return $this->mImplicitGroups
;
3238 * Returns the groups the user has belonged to.
3240 * The user may still belong to the returned groups. Compare with getGroups().
3242 * The function will not return groups the user had belonged to before MW 1.17
3244 * @return array Names of the groups the user has belonged to.
3246 public function getFormerGroups() {
3249 if ( is_null( $this->mFormerGroups
) ) {
3250 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3251 ?
wfGetDB( DB_MASTER
)
3252 : wfGetDB( DB_REPLICA
);
3253 $res = $db->select( 'user_former_groups',
3255 [ 'ufg_user' => $this->mId
],
3257 $this->mFormerGroups
= [];
3258 foreach ( $res as $row ) {
3259 $this->mFormerGroups
[] = $row->ufg_group
;
3263 return $this->mFormerGroups
;
3267 * Get the user's edit count.
3268 * @return int|null Null for anonymous users
3270 public function getEditCount() {
3271 if ( !$this->getId() ) {
3275 if ( $this->mEditCount
=== null ) {
3276 /* Populate the count, if it has not been populated yet */
3277 $dbr = wfGetDB( DB_REPLICA
);
3278 // check if the user_editcount field has been initialized
3279 $count = $dbr->selectField(
3280 'user', 'user_editcount',
3281 [ 'user_id' => $this->mId
],
3285 if ( $count === null ) {
3286 // it has not been initialized. do so.
3287 $count = $this->initEditCount();
3289 $this->mEditCount
= $count;
3291 return (int)$this->mEditCount
;
3295 * Add the user to the given group.
3296 * This takes immediate effect.
3297 * @param string $group Name of the group to add
3300 public function addGroup( $group ) {
3303 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group ] ) ) {
3307 $dbw = wfGetDB( DB_MASTER
);
3308 if ( $this->getId() ) {
3309 $dbw->insert( 'user_groups',
3311 'ug_user' => $this->getId(),
3312 'ug_group' => $group,
3318 $this->loadGroups();
3319 $this->mGroups
[] = $group;
3320 // In case loadGroups was not called before, we now have the right twice.
3321 // Get rid of the duplicate.
3322 $this->mGroups
= array_unique( $this->mGroups
);
3324 // Refresh the groups caches, and clear the rights cache so it will be
3325 // refreshed on the next call to $this->getRights().
3326 $this->getEffectiveGroups( true );
3327 $this->mRights
= null;
3329 $this->invalidateCache();
3335 * Remove the user from the given group.
3336 * This takes immediate effect.
3337 * @param string $group Name of the group to remove
3340 public function removeGroup( $group ) {
3342 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3346 $dbw = wfGetDB( DB_MASTER
);
3347 $dbw->delete( 'user_groups',
3349 'ug_user' => $this->getId(),
3350 'ug_group' => $group,
3353 // Remember that the user was in this group
3354 $dbw->insert( 'user_former_groups',
3356 'ufg_user' => $this->getId(),
3357 'ufg_group' => $group,
3363 $this->loadGroups();
3364 $this->mGroups
= array_diff( $this->mGroups
, [ $group ] );
3366 // Refresh the groups caches, and clear the rights cache so it will be
3367 // refreshed on the next call to $this->getRights().
3368 $this->getEffectiveGroups( true );
3369 $this->mRights
= null;
3371 $this->invalidateCache();
3377 * Get whether the user is logged in
3380 public function isLoggedIn() {
3381 return $this->getId() != 0;
3385 * Get whether the user is anonymous
3388 public function isAnon() {
3389 return !$this->isLoggedIn();
3393 * @return bool Whether this user is flagged as being a bot role account
3396 public function isBot() {
3397 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3402 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3408 * Check if user is allowed to access a feature / make an action
3410 * @param string ... Permissions to test
3411 * @return bool True if user is allowed to perform *any* of the given actions
3413 public function isAllowedAny() {
3414 $permissions = func_get_args();
3415 foreach ( $permissions as $permission ) {
3416 if ( $this->isAllowed( $permission ) ) {
3425 * @param string ... Permissions to test
3426 * @return bool True if the user is allowed to perform *all* of the given actions
3428 public function isAllowedAll() {
3429 $permissions = func_get_args();
3430 foreach ( $permissions as $permission ) {
3431 if ( !$this->isAllowed( $permission ) ) {
3439 * Internal mechanics of testing a permission
3440 * @param string $action
3443 public function isAllowed( $action = '' ) {
3444 if ( $action === '' ) {
3445 return true; // In the spirit of DWIM
3447 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3448 // by misconfiguration: 0 == 'foo'
3449 return in_array( $action, $this->getRights(), true );
3453 * Check whether to enable recent changes patrol features for this user
3454 * @return bool True or false
3456 public function useRCPatrol() {
3457 global $wgUseRCPatrol;
3458 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3462 * Check whether to enable new pages patrol features for this user
3463 * @return bool True or false
3465 public function useNPPatrol() {
3466 global $wgUseRCPatrol, $wgUseNPPatrol;
3468 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3469 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3474 * Check whether to enable new files patrol features for this user
3475 * @return bool True or false
3477 public function useFilePatrol() {
3478 global $wgUseRCPatrol, $wgUseFilePatrol;
3480 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3481 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3486 * Get the WebRequest object to use with this object
3488 * @return WebRequest
3490 public function getRequest() {
3491 if ( $this->mRequest
) {
3492 return $this->mRequest
;
3500 * Check the watched status of an article.
3501 * @since 1.22 $checkRights parameter added
3502 * @param Title $title Title of the article to look at
3503 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3504 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3507 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3508 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3509 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3516 * @since 1.22 $checkRights parameter added
3517 * @param Title $title Title of the article to look at
3518 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3519 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3521 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3522 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3523 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3525 [ $title->getSubjectPage(), $title->getTalkPage() ]
3528 $this->invalidateCache();
3532 * Stop watching an article.
3533 * @since 1.22 $checkRights parameter added
3534 * @param Title $title Title of the article to look at
3535 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3536 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3538 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3539 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3540 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3541 $store->removeWatch( $this, $title->getSubjectPage() );
3542 $store->removeWatch( $this, $title->getTalkPage() );
3544 $this->invalidateCache();
3548 * Clear the user's notification timestamp for the given title.
3549 * If e-notif e-mails are on, they will receive notification mails on
3550 * the next change of the page if it's watched etc.
3551 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3552 * @param Title $title Title of the article to look at
3553 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3555 public function clearNotification( &$title, $oldid = 0 ) {
3556 global $wgUseEnotif, $wgShowUpdatedMarker;
3558 // Do nothing if the database is locked to writes
3559 if ( wfReadOnly() ) {
3563 // Do nothing if not allowed to edit the watchlist
3564 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3568 // If we're working on user's talk page, we should update the talk page message indicator
3569 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3570 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$this, $oldid ] ) ) {
3574 // Try to update the DB post-send and only if needed...
3575 DeferredUpdates
::addCallableUpdate( function() use ( $title, $oldid ) {
3576 if ( !$this->getNewtalk() ) {
3577 return; // no notifications to clear
3580 // Delete the last notifications (they stack up)
3581 $this->setNewtalk( false );
3583 // If there is a new, unseen, revision, use its timestamp
3585 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
3588 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
3593 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3597 if ( $this->isAnon() ) {
3598 // Nothing else to do...
3602 // Only update the timestamp if the page is being watched.
3603 // The query to find out if it is watched is cached both in memcached and per-invocation,
3604 // and when it does have to be executed, it can be on a replica DB
3605 // If this is the user's newtalk page, we always update the timestamp
3607 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3611 MediaWikiServices
::getInstance()->getWatchedItemStore()
3612 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
3616 * Resets all of the given user's page-change notification timestamps.
3617 * If e-notif e-mails are on, they will receive notification mails on
3618 * the next change of any watched page.
3619 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3621 public function clearAllNotifications() {
3622 global $wgUseEnotif, $wgShowUpdatedMarker;
3623 // Do nothing if not allowed to edit the watchlist
3624 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
3628 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3629 $this->setNewtalk( false );
3633 $id = $this->getId();
3638 $dbw = wfGetDB( DB_MASTER
);
3639 $asOfTimes = array_unique( $dbw->selectFieldValues(
3641 'wl_notificationtimestamp',
3642 [ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ],
3644 [ 'ORDER BY' => 'wl_notificationtimestamp DESC', 'LIMIT' => 500 ]
3646 if ( !$asOfTimes ) {
3649 // Immediately update the most recent touched rows, which hopefully covers what
3650 // the user sees on the watchlist page before pressing "mark all pages visited"....
3653 [ 'wl_notificationtimestamp' => null ],
3654 [ 'wl_user' => $id, 'wl_notificationtimestamp' => $asOfTimes ],
3657 // ...and finish the older ones in a post-send update with lag checks...
3658 DeferredUpdates
::addUpdate( new AutoCommitUpdate(
3661 function () use ( $dbw, $id ) {
3662 global $wgUpdateRowsPerQuery;
3664 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
3665 $ticket = $lbFactory->getEmptyTransactionTicket( __METHOD__
);
3666 $asOfTimes = array_unique( $dbw->selectFieldValues(
3668 'wl_notificationtimestamp',
3669 [ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ],
3672 foreach ( array_chunk( $asOfTimes, $wgUpdateRowsPerQuery ) as $asOfTimeBatch ) {
3675 [ 'wl_notificationtimestamp' => null ],
3676 [ 'wl_user' => $id, 'wl_notificationtimestamp' => $asOfTimeBatch ],
3679 $lbFactory->commitAndWaitForReplication( __METHOD__
, $ticket );
3683 // We also need to clear here the "you have new message" notification for the own
3684 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
3688 * Set a cookie on the user's client. Wrapper for
3689 * WebResponse::setCookie
3690 * @deprecated since 1.27
3691 * @param string $name Name of the cookie to set
3692 * @param string $value Value to set
3693 * @param int $exp Expiration time, as a UNIX time value;
3694 * if 0 or not specified, use the default $wgCookieExpiration
3695 * @param bool $secure
3696 * true: Force setting the secure attribute when setting the cookie
3697 * false: Force NOT setting the secure attribute when setting the cookie
3698 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3699 * @param array $params Array of options sent passed to WebResponse::setcookie()
3700 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3703 protected function setCookie(
3704 $name, $value, $exp = 0, $secure = null, $params = [], $request = null
3706 wfDeprecated( __METHOD__
, '1.27' );
3707 if ( $request === null ) {
3708 $request = $this->getRequest();
3710 $params['secure'] = $secure;
3711 $request->response()->setCookie( $name, $value, $exp, $params );
3715 * Clear a cookie on the user's client
3716 * @deprecated since 1.27
3717 * @param string $name Name of the cookie to clear
3718 * @param bool $secure
3719 * true: Force setting the secure attribute when setting the cookie
3720 * false: Force NOT setting the secure attribute when setting the cookie
3721 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3722 * @param array $params Array of options sent passed to WebResponse::setcookie()
3724 protected function clearCookie( $name, $secure = null, $params = [] ) {
3725 wfDeprecated( __METHOD__
, '1.27' );
3726 $this->setCookie( $name, '', time() - 86400, $secure, $params );
3730 * Set an extended login cookie on the user's client. The expiry of the cookie
3731 * is controlled by the $wgExtendedLoginCookieExpiration configuration
3734 * @see User::setCookie
3736 * @deprecated since 1.27
3737 * @param string $name Name of the cookie to set
3738 * @param string $value Value to set
3739 * @param bool $secure
3740 * true: Force setting the secure attribute when setting the cookie
3741 * false: Force NOT setting the secure attribute when setting the cookie
3742 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3744 protected function setExtendedLoginCookie( $name, $value, $secure ) {
3745 global $wgExtendedLoginCookieExpiration, $wgCookieExpiration;
3747 wfDeprecated( __METHOD__
, '1.27' );
3750 $exp +
= $wgExtendedLoginCookieExpiration !== null
3751 ?
$wgExtendedLoginCookieExpiration
3752 : $wgCookieExpiration;
3754 $this->setCookie( $name, $value, $exp, $secure );
3758 * Persist this user's session (e.g. set cookies)
3760 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3762 * @param bool $secure Whether to force secure/insecure cookies or use default
3763 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3765 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3767 if ( 0 == $this->mId
) {
3771 $session = $this->getRequest()->getSession();
3772 if ( $request && $session->getRequest() !== $request ) {
3773 $session = $session->sessionWithRequest( $request );
3775 $delay = $session->delaySave();
3777 if ( !$session->getUser()->equals( $this ) ) {
3778 if ( !$session->canSetUser() ) {
3779 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3780 ->warning( __METHOD__
.
3781 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
3785 $session->setUser( $this );
3788 $session->setRememberUser( $rememberMe );
3789 if ( $secure !== null ) {
3790 $session->setForceHTTPS( $secure );
3793 $session->persist();
3795 ScopedCallback
::consume( $delay );
3799 * Log this user out.
3801 public function logout() {
3802 if ( Hooks
::run( 'UserLogout', [ &$this ] ) ) {
3808 * Clear the user's session, and reset the instance cache.
3811 public function doLogout() {
3812 $session = $this->getRequest()->getSession();
3813 if ( !$session->canSetUser() ) {
3814 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3815 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
3816 $error = 'immutable';
3817 } elseif ( !$session->getUser()->equals( $this ) ) {
3818 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3819 ->warning( __METHOD__
.
3820 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
3822 // But we still may as well make this user object anon
3823 $this->clearInstanceCache( 'defaults' );
3824 $error = 'wronguser';
3826 $this->clearInstanceCache( 'defaults' );
3827 $delay = $session->delaySave();
3828 $session->unpersist(); // Clear cookies (T127436)
3829 $session->setLoggedOutTimestamp( time() );
3830 $session->setUser( new User
);
3831 $session->set( 'wsUserID', 0 ); // Other code expects this
3832 $session->resetAllTokens();
3833 ScopedCallback
::consume( $delay );
3836 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
3837 'event' => 'logout',
3838 'successful' => $error === false,
3839 'status' => $error ?
: 'success',
3844 * Save this user's settings into the database.
3845 * @todo Only rarely do all these fields need to be set!
3847 public function saveSettings() {
3848 if ( wfReadOnly() ) {
3849 // @TODO: caller should deal with this instead!
3850 // This should really just be an exception.
3851 MWExceptionHandler
::logException( new DBExpectedError(
3853 "Could not update user with ID '{$this->mId}'; DB is read-only."
3859 if ( 0 == $this->mId
) {
3863 // Get a new user_touched that is higher than the old one.
3864 // This will be used for a CAS check as a last-resort safety
3865 // check against race conditions and replica DB lag.
3866 $newTouched = $this->newTouchedTimestamp();
3868 $dbw = wfGetDB( DB_MASTER
);
3869 $dbw->update( 'user',
3871 'user_name' => $this->mName
,
3872 'user_real_name' => $this->mRealName
,
3873 'user_email' => $this->mEmail
,
3874 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3875 'user_touched' => $dbw->timestamp( $newTouched ),
3876 'user_token' => strval( $this->mToken
),
3877 'user_email_token' => $this->mEmailToken
,
3878 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
3879 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
3880 'user_id' => $this->mId
,
3884 if ( !$dbw->affectedRows() ) {
3885 // Maybe the problem was a missed cache update; clear it to be safe
3886 $this->clearSharedCache( 'refresh' );
3887 // User was changed in the meantime or loaded with stale data
3888 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
3889 throw new MWException(
3890 "CAS update failed on user_touched for user ID '{$this->mId}' (read from $from);" .
3891 " the version of the user to be saved is older than the current version."
3895 $this->mTouched
= $newTouched;
3896 $this->saveOptions();
3898 Hooks
::run( 'UserSaveSettings', [ $this ] );
3899 $this->clearSharedCache();
3900 $this->getUserPage()->invalidateCache();
3904 * If only this user's username is known, and it exists, return the user ID.
3906 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
3909 public function idForName( $flags = 0 ) {
3910 $s = trim( $this->getName() );
3915 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
3916 ?
wfGetDB( DB_MASTER
)
3917 : wfGetDB( DB_REPLICA
);
3919 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
3920 ?
[ 'LOCK IN SHARE MODE' ]
3923 $id = $db->selectField( 'user',
3924 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
3930 * Add a user to the database, return the user object
3932 * @param string $name Username to add
3933 * @param array $params Array of Strings Non-default parameters to save to
3934 * the database as user_* fields:
3935 * - email: The user's email address.
3936 * - email_authenticated: The email authentication timestamp.
3937 * - real_name: The user's real name.
3938 * - options: An associative array of non-default options.
3939 * - token: Random authentication token. Do not set.
3940 * - registration: Registration timestamp. Do not set.
3942 * @return User|null User object, or null if the username already exists.
3944 public static function createNew( $name, $params = [] ) {
3945 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
3946 if ( isset( $params[$field] ) ) {
3947 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
3948 unset( $params[$field] );
3954 $user->setToken(); // init token
3955 if ( isset( $params['options'] ) ) {
3956 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
3957 unset( $params['options'] );
3959 $dbw = wfGetDB( DB_MASTER
);
3960 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3962 $noPass = PasswordFactory
::newInvalidPassword()->toString();
3965 'user_id' => $seqVal,
3966 'user_name' => $name,
3967 'user_password' => $noPass,
3968 'user_newpassword' => $noPass,
3969 'user_email' => $user->mEmail
,
3970 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
3971 'user_real_name' => $user->mRealName
,
3972 'user_token' => strval( $user->mToken
),
3973 'user_registration' => $dbw->timestamp( $user->mRegistration
),
3974 'user_editcount' => 0,
3975 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
3977 foreach ( $params as $name => $value ) {
3978 $fields["user_$name"] = $value;
3980 $dbw->insert( 'user', $fields, __METHOD__
, [ 'IGNORE' ] );
3981 if ( $dbw->affectedRows() ) {
3982 $newUser = User
::newFromId( $dbw->insertId() );
3990 * Add this existing user object to the database. If the user already
3991 * exists, a fatal status object is returned, and the user object is
3992 * initialised with the data from the database.
3994 * Previously, this function generated a DB error due to a key conflict
3995 * if the user already existed. Many extension callers use this function
3996 * in code along the lines of:
3998 * $user = User::newFromName( $name );
3999 * if ( !$user->isLoggedIn() ) {
4000 * $user->addToDatabase();
4002 * // do something with $user...
4004 * However, this was vulnerable to a race condition (bug 16020). By
4005 * initialising the user object if the user exists, we aim to support this
4006 * calling sequence as far as possible.
4008 * Note that if the user exists, this function will acquire a write lock,
4009 * so it is still advisable to make the call conditional on isLoggedIn(),
4010 * and to commit the transaction after calling.
4012 * @throws MWException
4015 public function addToDatabase() {
4017 if ( !$this->mToken
) {
4018 $this->setToken(); // init token
4021 $this->mTouched
= $this->newTouchedTimestamp();
4023 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4025 $dbw = wfGetDB( DB_MASTER
);
4026 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
4027 $dbw->insert( 'user',
4029 'user_id' => $seqVal,
4030 'user_name' => $this->mName
,
4031 'user_password' => $noPass,
4032 'user_newpassword' => $noPass,
4033 'user_email' => $this->mEmail
,
4034 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4035 'user_real_name' => $this->mRealName
,
4036 'user_token' => strval( $this->mToken
),
4037 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4038 'user_editcount' => 0,
4039 'user_touched' => $dbw->timestamp( $this->mTouched
),
4043 if ( !$dbw->affectedRows() ) {
4044 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4045 $this->mId
= $dbw->selectField(
4048 [ 'user_name' => $this->mName
],
4050 [ 'LOCK IN SHARE MODE' ]
4054 if ( $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4059 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
4060 "to insert user '{$this->mName}' row, but it was not present in select!" );
4062 return Status
::newFatal( 'userexists' );
4064 $this->mId
= $dbw->insertId();
4065 self
::$idCacheByName[$this->mName
] = $this->mId
;
4067 // Clear instance cache other than user table data, which is already accurate
4068 $this->clearInstanceCache();
4070 $this->saveOptions();
4071 return Status
::newGood();
4075 * If this user is logged-in and blocked,
4076 * block any IP address they've successfully logged in from.
4077 * @return bool A block was spread
4079 public function spreadAnyEditBlock() {
4080 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4081 return $this->spreadBlock();
4088 * If this (non-anonymous) user is blocked,
4089 * block the IP address they've successfully logged in from.
4090 * @return bool A block was spread
4092 protected function spreadBlock() {
4093 wfDebug( __METHOD__
. "()\n" );
4095 if ( $this->mId
== 0 ) {
4099 $userblock = Block
::newFromTarget( $this->getName() );
4100 if ( !$userblock ) {
4104 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4108 * Get whether the user is explicitly blocked from account creation.
4109 * @return bool|Block
4111 public function isBlockedFromCreateAccount() {
4112 $this->getBlockedStatus();
4113 if ( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
4114 return $this->mBlock
;
4117 # bug 13611: if the IP address the user is trying to create an account from is
4118 # blocked with createaccount disabled, prevent new account creation there even
4119 # when the user is logged in
4120 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4121 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4123 return $this->mBlockedFromCreateAccount
instanceof Block
4124 && $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
4125 ?
$this->mBlockedFromCreateAccount
4130 * Get whether the user is blocked from using Special:Emailuser.
4133 public function isBlockedFromEmailuser() {
4134 $this->getBlockedStatus();
4135 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
4139 * Get whether the user is allowed to create an account.
4142 public function isAllowedToCreateAccount() {
4143 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4147 * Get this user's personal page title.
4149 * @return Title User's personal page title
4151 public function getUserPage() {
4152 return Title
::makeTitle( NS_USER
, $this->getName() );
4156 * Get this user's talk page title.
4158 * @return Title User's talk page title
4160 public function getTalkPage() {
4161 $title = $this->getUserPage();
4162 return $title->getTalkPage();
4166 * Determine whether the user is a newbie. Newbies are either
4167 * anonymous IPs, or the most recently created accounts.
4170 public function isNewbie() {
4171 return !$this->isAllowed( 'autoconfirmed' );
4175 * Check to see if the given clear-text password is one of the accepted passwords
4176 * @deprecated since 1.27, use AuthManager instead
4177 * @param string $password User password
4178 * @return bool True if the given password is correct, otherwise False
4180 public function checkPassword( $password ) {
4181 $manager = AuthManager
::singleton();
4182 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4183 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4185 'username' => $this->getName(),
4186 'password' => $password,
4189 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4190 switch ( $res->status
) {
4191 case AuthenticationResponse
::PASS
:
4193 case AuthenticationResponse
::FAIL
:
4194 // Hope it's not a PreAuthenticationProvider that failed...
4195 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4196 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4199 throw new BadMethodCallException(
4200 'AuthManager returned a response unsupported by ' . __METHOD__
4206 * Check if the given clear-text password matches the temporary password
4207 * sent by e-mail for password reset operations.
4209 * @deprecated since 1.27, use AuthManager instead
4210 * @param string $plaintext
4211 * @return bool True if matches, false otherwise
4213 public function checkTemporaryPassword( $plaintext ) {
4214 // Can't check the temporary password individually.
4215 return $this->checkPassword( $plaintext );
4219 * Initialize (if necessary) and return a session token value
4220 * which can be used in edit forms to show that the user's
4221 * login credentials aren't being hijacked with a foreign form
4225 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4226 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4227 * @return MediaWiki\Session\Token The new edit token
4229 public function getEditTokenObject( $salt = '', $request = null ) {
4230 if ( $this->isAnon() ) {
4231 return new LoggedOutEditToken();
4235 $request = $this->getRequest();
4237 return $request->getSession()->getToken( $salt );
4241 * Initialize (if necessary) and return a session token value
4242 * which can be used in edit forms to show that the user's
4243 * login credentials aren't being hijacked with a foreign form
4246 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4249 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4250 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4251 * @return string The new edit token
4253 public function getEditToken( $salt = '', $request = null ) {
4254 return $this->getEditTokenObject( $salt, $request )->toString();
4258 * Get the embedded timestamp from a token.
4259 * @deprecated since 1.27, use \MediaWiki\Session\Token::getTimestamp instead.
4260 * @param string $val Input token
4263 public static function getEditTokenTimestamp( $val ) {
4264 wfDeprecated( __METHOD__
, '1.27' );
4265 return MediaWiki\Session\Token
::getTimestamp( $val );
4269 * Check given value against the token value stored in the session.
4270 * A match should confirm that the form was submitted from the
4271 * user's own login session, not a form submission from a third-party
4274 * @param string $val Input value to compare
4275 * @param string $salt Optional function-specific data for hashing
4276 * @param WebRequest|null $request Object to use or null to use $wgRequest
4277 * @param int $maxage Fail tokens older than this, in seconds
4278 * @return bool Whether the token matches
4280 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4281 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4285 * Check given value against the token value stored in the session,
4286 * ignoring the suffix.
4288 * @param string $val Input value to compare
4289 * @param string $salt Optional function-specific data for hashing
4290 * @param WebRequest|null $request Object to use or null to use $wgRequest
4291 * @param int $maxage Fail tokens older than this, in seconds
4292 * @return bool Whether the token matches
4294 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4295 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4296 return $this->matchEditToken( $val, $salt, $request, $maxage );
4300 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4301 * mail to the user's given address.
4303 * @param string $type Message to send, either "created", "changed" or "set"
4306 public function sendConfirmationMail( $type = 'created' ) {
4308 $expiration = null; // gets passed-by-ref and defined in next line.
4309 $token = $this->confirmationToken( $expiration );
4310 $url = $this->confirmationTokenUrl( $token );
4311 $invalidateURL = $this->invalidationTokenUrl( $token );
4312 $this->saveSettings();
4314 if ( $type == 'created' ||
$type === false ) {
4315 $message = 'confirmemail_body';
4316 } elseif ( $type === true ) {
4317 $message = 'confirmemail_body_changed';
4319 // Messages: confirmemail_body_changed, confirmemail_body_set
4320 $message = 'confirmemail_body_' . $type;
4323 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4324 wfMessage( $message,
4325 $this->getRequest()->getIP(),
4328 $wgLang->userTimeAndDate( $expiration, $this ),
4330 $wgLang->userDate( $expiration, $this ),
4331 $wgLang->userTime( $expiration, $this ) )->text() );
4335 * Send an e-mail to this user's account. Does not check for
4336 * confirmed status or validity.
4338 * @param string $subject Message subject
4339 * @param string $body Message body
4340 * @param User|null $from Optional sending user; if unspecified, default
4341 * $wgPasswordSender will be used.
4342 * @param string $replyto Reply-To address
4345 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4346 global $wgPasswordSender;
4348 if ( $from instanceof User
) {
4349 $sender = MailAddress
::newFromUser( $from );
4351 $sender = new MailAddress( $wgPasswordSender,
4352 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4354 $to = MailAddress
::newFromUser( $this );
4356 return UserMailer
::send( $to, $sender, $subject, $body, [
4357 'replyTo' => $replyto,
4362 * Generate, store, and return a new e-mail confirmation code.
4363 * A hash (unsalted, since it's used as a key) is stored.
4365 * @note Call saveSettings() after calling this function to commit
4366 * this change to the database.
4368 * @param string &$expiration Accepts the expiration time
4369 * @return string New token
4371 protected function confirmationToken( &$expiration ) {
4372 global $wgUserEmailConfirmationTokenExpiry;
4374 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4375 $expiration = wfTimestamp( TS_MW
, $expires );
4377 $token = MWCryptRand
::generateHex( 32 );
4378 $hash = md5( $token );
4379 $this->mEmailToken
= $hash;
4380 $this->mEmailTokenExpires
= $expiration;
4385 * Return a URL the user can use to confirm their email address.
4386 * @param string $token Accepts the email confirmation token
4387 * @return string New token URL
4389 protected function confirmationTokenUrl( $token ) {
4390 return $this->getTokenUrl( 'ConfirmEmail', $token );
4394 * Return a URL the user can use to invalidate their email address.
4395 * @param string $token Accepts the email confirmation token
4396 * @return string New token URL
4398 protected function invalidationTokenUrl( $token ) {
4399 return $this->getTokenUrl( 'InvalidateEmail', $token );
4403 * Internal function to format the e-mail validation/invalidation URLs.
4404 * This uses a quickie hack to use the
4405 * hardcoded English names of the Special: pages, for ASCII safety.
4407 * @note Since these URLs get dropped directly into emails, using the
4408 * short English names avoids insanely long URL-encoded links, which
4409 * also sometimes can get corrupted in some browsers/mailers
4410 * (bug 6957 with Gmail and Internet Explorer).
4412 * @param string $page Special page
4413 * @param string $token Token
4414 * @return string Formatted URL
4416 protected function getTokenUrl( $page, $token ) {
4417 // Hack to bypass localization of 'Special:'
4418 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4419 return $title->getCanonicalURL();
4423 * Mark the e-mail address confirmed.
4425 * @note Call saveSettings() after calling this function to commit the change.
4429 public function confirmEmail() {
4430 // Check if it's already confirmed, so we don't touch the database
4431 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4432 if ( !$this->isEmailConfirmed() ) {
4433 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4434 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4440 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4441 * address if it was already confirmed.
4443 * @note Call saveSettings() after calling this function to commit the change.
4444 * @return bool Returns true
4446 public function invalidateEmail() {
4448 $this->mEmailToken
= null;
4449 $this->mEmailTokenExpires
= null;
4450 $this->setEmailAuthenticationTimestamp( null );
4452 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4457 * Set the e-mail authentication timestamp.
4458 * @param string $timestamp TS_MW timestamp
4460 public function setEmailAuthenticationTimestamp( $timestamp ) {
4462 $this->mEmailAuthenticated
= $timestamp;
4463 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4467 * Is this user allowed to send e-mails within limits of current
4468 * site configuration?
4471 public function canSendEmail() {
4472 global $wgEnableEmail, $wgEnableUserEmail;
4473 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4476 $canSend = $this->isEmailConfirmed();
4477 Hooks
::run( 'UserCanSendEmail', [ &$this, &$canSend ] );
4482 * Is this user allowed to receive e-mails within limits of current
4483 * site configuration?
4486 public function canReceiveEmail() {
4487 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4491 * Is this user's e-mail address valid-looking and confirmed within
4492 * limits of the current site configuration?
4494 * @note If $wgEmailAuthentication is on, this may require the user to have
4495 * confirmed their address by returning a code or using a password
4496 * sent to the address from the wiki.
4500 public function isEmailConfirmed() {
4501 global $wgEmailAuthentication;
4504 if ( Hooks
::run( 'EmailConfirmed', [ &$this, &$confirmed ] ) ) {
4505 if ( $this->isAnon() ) {
4508 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4511 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4521 * Check whether there is an outstanding request for e-mail confirmation.
4524 public function isEmailConfirmationPending() {
4525 global $wgEmailAuthentication;
4526 return $wgEmailAuthentication &&
4527 !$this->isEmailConfirmed() &&
4528 $this->mEmailToken
&&
4529 $this->mEmailTokenExpires
> wfTimestamp();
4533 * Get the timestamp of account creation.
4535 * @return string|bool|null Timestamp of account creation, false for
4536 * non-existent/anonymous user accounts, or null if existing account
4537 * but information is not in database.
4539 public function getRegistration() {
4540 if ( $this->isAnon() ) {
4544 return $this->mRegistration
;
4548 * Get the timestamp of the first edit
4550 * @return string|bool Timestamp of first edit, or false for
4551 * non-existent/anonymous user accounts.
4553 public function getFirstEditTimestamp() {
4554 if ( $this->getId() == 0 ) {
4555 return false; // anons
4557 $dbr = wfGetDB( DB_REPLICA
);
4558 $time = $dbr->selectField( 'revision', 'rev_timestamp',
4559 [ 'rev_user' => $this->getId() ],
4561 [ 'ORDER BY' => 'rev_timestamp ASC' ]
4564 return false; // no edits
4566 return wfTimestamp( TS_MW
, $time );
4570 * Get the permissions associated with a given list of groups
4572 * @param array $groups Array of Strings List of internal group names
4573 * @return array Array of Strings List of permission key names for given groups combined
4575 public static function getGroupPermissions( $groups ) {
4576 global $wgGroupPermissions, $wgRevokePermissions;
4578 // grant every granted permission first
4579 foreach ( $groups as $group ) {
4580 if ( isset( $wgGroupPermissions[$group] ) ) {
4581 $rights = array_merge( $rights,
4582 // array_filter removes empty items
4583 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4586 // now revoke the revoked permissions
4587 foreach ( $groups as $group ) {
4588 if ( isset( $wgRevokePermissions[$group] ) ) {
4589 $rights = array_diff( $rights,
4590 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4593 return array_unique( $rights );
4597 * Get all the groups who have a given permission
4599 * @param string $role Role to check
4600 * @return array Array of Strings List of internal group names with the given permission
4602 public static function getGroupsWithPermission( $role ) {
4603 global $wgGroupPermissions;
4604 $allowedGroups = [];
4605 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4606 if ( self
::groupHasPermission( $group, $role ) ) {
4607 $allowedGroups[] = $group;
4610 return $allowedGroups;
4614 * Check, if the given group has the given permission
4616 * If you're wanting to check whether all users have a permission, use
4617 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4621 * @param string $group Group to check
4622 * @param string $role Role to check
4625 public static function groupHasPermission( $group, $role ) {
4626 global $wgGroupPermissions, $wgRevokePermissions;
4627 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4628 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4632 * Check if all users may be assumed to have the given permission
4634 * We generally assume so if the right is granted to '*' and isn't revoked
4635 * on any group. It doesn't attempt to take grants or other extension
4636 * limitations on rights into account in the general case, though, as that
4637 * would require it to always return false and defeat the purpose.
4638 * Specifically, session-based rights restrictions (such as OAuth or bot
4639 * passwords) are applied based on the current session.
4642 * @param string $right Right to check
4645 public static function isEveryoneAllowed( $right ) {
4646 global $wgGroupPermissions, $wgRevokePermissions;
4649 // Use the cached results, except in unit tests which rely on
4650 // being able change the permission mid-request
4651 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
4652 return $cache[$right];
4655 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
4656 $cache[$right] = false;
4660 // If it's revoked anywhere, then everyone doesn't have it
4661 foreach ( $wgRevokePermissions as $rights ) {
4662 if ( isset( $rights[$right] ) && $rights[$right] ) {
4663 $cache[$right] = false;
4668 // Remove any rights that aren't allowed to the global-session user,
4669 // unless there are no sessions for this endpoint.
4670 if ( !defined( 'MW_NO_SESSION' ) ) {
4671 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
4672 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
4673 $cache[$right] = false;
4678 // Allow extensions to say false
4679 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
4680 $cache[$right] = false;
4684 $cache[$right] = true;
4689 * Get the localized descriptive name for a group, if it exists
4691 * @param string $group Internal group name
4692 * @return string Localized descriptive group name
4694 public static function getGroupName( $group ) {
4695 $msg = wfMessage( "group-$group" );
4696 return $msg->isBlank() ?
$group : $msg->text();
4700 * Get the localized descriptive name for a member of a group, if it exists
4702 * @param string $group Internal group name
4703 * @param string $username Username for gender (since 1.19)
4704 * @return string Localized name for group member
4706 public static function getGroupMember( $group, $username = '#' ) {
4707 $msg = wfMessage( "group-$group-member", $username );
4708 return $msg->isBlank() ?
$group : $msg->text();
4712 * Return the set of defined explicit groups.
4713 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4714 * are not included, as they are defined automatically, not in the database.
4715 * @return array Array of internal group names
4717 public static function getAllGroups() {
4718 global $wgGroupPermissions, $wgRevokePermissions;
4720 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4721 self
::getImplicitGroups()
4726 * Get a list of all available permissions.
4727 * @return string[] Array of permission names
4729 public static function getAllRights() {
4730 if ( self
::$mAllRights === false ) {
4731 global $wgAvailableRights;
4732 if ( count( $wgAvailableRights ) ) {
4733 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
4735 self
::$mAllRights = self
::$mCoreRights;
4737 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
4739 return self
::$mAllRights;
4743 * Get a list of implicit groups
4744 * @return array Array of Strings Array of internal group names
4746 public static function getImplicitGroups() {
4747 global $wgImplicitGroups;
4749 $groups = $wgImplicitGroups;
4750 # Deprecated, use $wgImplicitGroups instead
4751 Hooks
::run( 'UserGetImplicitGroups', [ &$groups ], '1.25' );
4757 * Get the title of a page describing a particular group
4759 * @param string $group Internal group name
4760 * @return Title|bool Title of the page if it exists, false otherwise
4762 public static function getGroupPage( $group ) {
4763 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
4764 if ( $msg->exists() ) {
4765 $title = Title
::newFromText( $msg->text() );
4766 if ( is_object( $title ) ) {
4774 * Create a link to the group in HTML, if available;
4775 * else return the group name.
4777 * @param string $group Internal name of the group
4778 * @param string $text The text of the link
4779 * @return string HTML link to the group
4781 public static function makeGroupLinkHTML( $group, $text = '' ) {
4782 if ( $text == '' ) {
4783 $text = self
::getGroupName( $group );
4785 $title = self
::getGroupPage( $group );
4787 return Linker
::link( $title, htmlspecialchars( $text ) );
4789 return htmlspecialchars( $text );
4794 * Create a link to the group in Wikitext, if available;
4795 * else return the group name.
4797 * @param string $group Internal name of the group
4798 * @param string $text The text of the link
4799 * @return string Wikilink to the group
4801 public static function makeGroupLinkWiki( $group, $text = '' ) {
4802 if ( $text == '' ) {
4803 $text = self
::getGroupName( $group );
4805 $title = self
::getGroupPage( $group );
4807 $page = $title->getFullText();
4808 return "[[$page|$text]]";
4815 * Returns an array of the groups that a particular group can add/remove.
4817 * @param string $group The group to check for whether it can add/remove
4818 * @return array Array( 'add' => array( addablegroups ),
4819 * 'remove' => array( removablegroups ),
4820 * 'add-self' => array( addablegroups to self),
4821 * 'remove-self' => array( removable groups from self) )
4823 public static function changeableByGroup( $group ) {
4824 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4833 if ( empty( $wgAddGroups[$group] ) ) {
4834 // Don't add anything to $groups
4835 } elseif ( $wgAddGroups[$group] === true ) {
4836 // You get everything
4837 $groups['add'] = self
::getAllGroups();
4838 } elseif ( is_array( $wgAddGroups[$group] ) ) {
4839 $groups['add'] = $wgAddGroups[$group];
4842 // Same thing for remove
4843 if ( empty( $wgRemoveGroups[$group] ) ) {
4845 } elseif ( $wgRemoveGroups[$group] === true ) {
4846 $groups['remove'] = self
::getAllGroups();
4847 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4848 $groups['remove'] = $wgRemoveGroups[$group];
4851 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4852 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
4853 foreach ( $wgGroupsAddToSelf as $key => $value ) {
4854 if ( is_int( $key ) ) {
4855 $wgGroupsAddToSelf['user'][] = $value;
4860 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
4861 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4862 if ( is_int( $key ) ) {
4863 $wgGroupsRemoveFromSelf['user'][] = $value;
4868 // Now figure out what groups the user can add to him/herself
4869 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
4871 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
4872 // No idea WHY this would be used, but it's there
4873 $groups['add-self'] = User
::getAllGroups();
4874 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4875 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4878 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4880 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4881 $groups['remove-self'] = User
::getAllGroups();
4882 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4883 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4890 * Returns an array of groups that this user can add and remove
4891 * @return array Array( 'add' => array( addablegroups ),
4892 * 'remove' => array( removablegroups ),
4893 * 'add-self' => array( addablegroups to self),
4894 * 'remove-self' => array( removable groups from self) )
4896 public function changeableGroups() {
4897 if ( $this->isAllowed( 'userrights' ) ) {
4898 // This group gives the right to modify everything (reverse-
4899 // compatibility with old "userrights lets you change
4901 // Using array_merge to make the groups reindexed
4902 $all = array_merge( User
::getAllGroups() );
4911 // Okay, it's not so simple, we will have to go through the arrays
4918 $addergroups = $this->getEffectiveGroups();
4920 foreach ( $addergroups as $addergroup ) {
4921 $groups = array_merge_recursive(
4922 $groups, $this->changeableByGroup( $addergroup )
4924 $groups['add'] = array_unique( $groups['add'] );
4925 $groups['remove'] = array_unique( $groups['remove'] );
4926 $groups['add-self'] = array_unique( $groups['add-self'] );
4927 $groups['remove-self'] = array_unique( $groups['remove-self'] );
4933 * Deferred version of incEditCountImmediate()
4935 public function incEditCount() {
4936 wfGetDB( DB_MASTER
)->onTransactionPreCommitOrIdle(
4938 $this->incEditCountImmediate();
4945 * Increment the user's edit-count field.
4946 * Will have no effect for anonymous users.
4949 public function incEditCountImmediate() {
4950 if ( $this->isAnon() ) {
4954 $dbw = wfGetDB( DB_MASTER
);
4955 // No rows will be "affected" if user_editcount is NULL
4958 [ 'user_editcount=user_editcount+1' ],
4959 [ 'user_id' => $this->getId(), 'user_editcount IS NOT NULL' ],
4962 // Lazy initialization check...
4963 if ( $dbw->affectedRows() == 0 ) {
4964 // Now here's a goddamn hack...
4965 $dbr = wfGetDB( DB_REPLICA
);
4966 if ( $dbr !== $dbw ) {
4967 // If we actually have a replica DB server, the count is
4968 // at least one behind because the current transaction
4969 // has not been committed and replicated.
4970 $this->mEditCount
= $this->initEditCount( 1 );
4972 // But if DB_REPLICA is selecting the master, then the
4973 // count we just read includes the revision that was
4974 // just added in the working transaction.
4975 $this->mEditCount
= $this->initEditCount();
4978 if ( $this->mEditCount
=== null ) {
4979 $this->getEditCount();
4980 $dbr = wfGetDB( DB_REPLICA
);
4981 $this->mEditCount +
= ( $dbr !== $dbw ) ?
1 : 0;
4983 $this->mEditCount++
;
4986 // Edit count in user cache too
4987 $this->invalidateCache();
4991 * Initialize user_editcount from data out of the revision table
4993 * @param int $add Edits to add to the count from the revision table
4994 * @return int Number of edits
4996 protected function initEditCount( $add = 0 ) {
4997 // Pull from a replica DB to be less cruel to servers
4998 // Accuracy isn't the point anyway here
4999 $dbr = wfGetDB( DB_REPLICA
);
5000 $count = (int)$dbr->selectField(
5003 [ 'rev_user' => $this->getId() ],
5006 $count = $count +
$add;
5008 $dbw = wfGetDB( DB_MASTER
);
5011 [ 'user_editcount' => $count ],
5012 [ 'user_id' => $this->getId() ],
5020 * Get the description of a given right
5022 * @param string $right Right to query
5023 * @return string Localized description of the right
5025 public static function getRightDescription( $right ) {
5026 $key = "right-$right";
5027 $msg = wfMessage( $key );
5028 return $msg->isBlank() ?
$right : $msg->text();
5032 * Make a new-style password hash
5034 * @param string $password Plain-text password
5035 * @param bool|string $salt Optional salt, may be random or the user ID.
5036 * If unspecified or false, will generate one automatically
5037 * @return string Password hash
5038 * @deprecated since 1.24, use Password class
5040 public static function crypt( $password, $salt = false ) {
5041 wfDeprecated( __METHOD__
, '1.24' );
5042 $passwordFactory = new PasswordFactory();
5043 $passwordFactory->init( RequestContext
::getMain()->getConfig() );
5044 $hash = $passwordFactory->newFromPlaintext( $password );
5045 return $hash->toString();
5049 * Compare a password hash with a plain-text password. Requires the user
5050 * ID if there's a chance that the hash is an old-style hash.
5052 * @param string $hash Password hash
5053 * @param string $password Plain-text password to compare
5054 * @param string|bool $userId User ID for old-style password salt
5057 * @deprecated since 1.24, use Password class
5059 public static function comparePasswords( $hash, $password, $userId = false ) {
5060 wfDeprecated( __METHOD__
, '1.24' );
5062 // Check for *really* old password hashes that don't even have a type
5063 // The old hash format was just an md5 hex hash, with no type information
5064 if ( preg_match( '/^[0-9a-f]{32}$/', $hash ) ) {
5065 global $wgPasswordSalt;
5066 if ( $wgPasswordSalt ) {
5067 $password = ":B:{$userId}:{$hash}";
5069 $password = ":A:{$hash}";
5073 $passwordFactory = new PasswordFactory();
5074 $passwordFactory->init( RequestContext
::getMain()->getConfig() );
5075 $hash = $passwordFactory->newFromCiphertext( $hash );
5076 return $hash->equals( $password );
5080 * Add a newuser log entry for this user.
5081 * Before 1.19 the return value was always true.
5083 * @deprecated since 1.27, AuthManager handles logging
5084 * @param string|bool $action Account creation type.
5085 * - String, one of the following values:
5086 * - 'create' for an anonymous user creating an account for himself.
5087 * This will force the action's performer to be the created user itself,
5088 * no matter the value of $wgUser
5089 * - 'create2' for a logged in user creating an account for someone else
5090 * - 'byemail' when the created user will receive its password by e-mail
5091 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5092 * - Boolean means whether the account was created by e-mail (deprecated):
5093 * - true will be converted to 'byemail'
5094 * - false will be converted to 'create' if this object is the same as
5095 * $wgUser and to 'create2' otherwise
5096 * @param string $reason User supplied reason
5099 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5100 return true; // disabled
5104 * Add an autocreate newuser log entry for this user
5105 * Used by things like CentralAuth and perhaps other authplugins.
5106 * Consider calling addNewUserLogEntry() directly instead.
5108 * @deprecated since 1.27, AuthManager handles logging
5111 public function addNewUserLogEntryAutoCreate() {
5112 $this->addNewUserLogEntry( 'autocreate' );
5118 * Load the user options either from cache, the database or an array
5120 * @param array $data Rows for the current user out of the user_properties table
5122 protected function loadOptions( $data = null ) {
5127 if ( $this->mOptionsLoaded
) {
5131 $this->mOptions
= self
::getDefaultOptions();
5133 if ( !$this->getId() ) {
5134 // For unlogged-in users, load language/variant options from request.
5135 // There's no need to do it for logged-in users: they can set preferences,
5136 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5137 // so don't override user's choice (especially when the user chooses site default).
5138 $variant = $wgContLang->getDefaultVariant();
5139 $this->mOptions
['variant'] = $variant;
5140 $this->mOptions
['language'] = $variant;
5141 $this->mOptionsLoaded
= true;
5145 // Maybe load from the object
5146 if ( !is_null( $this->mOptionOverrides
) ) {
5147 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5148 foreach ( $this->mOptionOverrides
as $key => $value ) {
5149 $this->mOptions
[$key] = $value;
5152 if ( !is_array( $data ) ) {
5153 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5154 // Load from database
5155 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5156 ?
wfGetDB( DB_MASTER
)
5157 : wfGetDB( DB_REPLICA
);
5159 $res = $dbr->select(
5161 [ 'up_property', 'up_value' ],
5162 [ 'up_user' => $this->getId() ],
5166 $this->mOptionOverrides
= [];
5168 foreach ( $res as $row ) {
5169 $data[$row->up_property
] = $row->up_value
;
5172 foreach ( $data as $property => $value ) {
5173 $this->mOptionOverrides
[$property] = $value;
5174 $this->mOptions
[$property] = $value;
5178 $this->mOptionsLoaded
= true;
5180 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5184 * Saves the non-default options for this user, as previously set e.g. via
5185 * setOption(), in the database's "user_properties" (preferences) table.
5186 * Usually used via saveSettings().
5188 protected function saveOptions() {
5189 $this->loadOptions();
5191 // Not using getOptions(), to keep hidden preferences in database
5192 $saveOptions = $this->mOptions
;
5194 // Allow hooks to abort, for instance to save to a global profile.
5195 // Reset options to default state before saving.
5196 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5200 $userId = $this->getId();
5202 $insert_rows = []; // all the new preference rows
5203 foreach ( $saveOptions as $key => $value ) {
5204 // Don't bother storing default values
5205 $defaultOption = self
::getDefaultOption( $key );
5206 if ( ( $defaultOption === null && $value !== false && $value !== null )
5207 ||
$value != $defaultOption
5210 'up_user' => $userId,
5211 'up_property' => $key,
5212 'up_value' => $value,
5217 $dbw = wfGetDB( DB_MASTER
);
5219 $res = $dbw->select( 'user_properties',
5220 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5222 // Find prior rows that need to be removed or updated. These rows will
5223 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5225 foreach ( $res as $row ) {
5226 if ( !isset( $saveOptions[$row->up_property
] )
5227 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5229 $keysDelete[] = $row->up_property
;
5233 if ( count( $keysDelete ) ) {
5234 // Do the DELETE by PRIMARY KEY for prior rows.
5235 // In the past a very large portion of calls to this function are for setting
5236 // 'rememberpassword' for new accounts (a preference that has since been removed).
5237 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5238 // caused gap locks on [max user ID,+infinity) which caused high contention since
5239 // updates would pile up on each other as they are for higher (newer) user IDs.
5240 // It might not be necessary these days, but it shouldn't hurt either.
5241 $dbw->delete( 'user_properties',
5242 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5244 // Insert the new preference rows
5245 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5249 * Lazily instantiate and return a factory object for making passwords
5251 * @deprecated since 1.27, create a PasswordFactory directly instead
5252 * @return PasswordFactory
5254 public static function getPasswordFactory() {
5255 wfDeprecated( __METHOD__
, '1.27' );
5256 $ret = new PasswordFactory();
5257 $ret->init( RequestContext
::getMain()->getConfig() );
5262 * Provide an array of HTML5 attributes to put on an input element
5263 * intended for the user to enter a new password. This may include
5264 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
5266 * Do *not* use this when asking the user to enter his current password!
5267 * Regardless of configuration, users may have invalid passwords for whatever
5268 * reason (e.g., they were set before requirements were tightened up).
5269 * Only use it when asking for a new password, like on account creation or
5272 * Obviously, you still need to do server-side checking.
5274 * NOTE: A combination of bugs in various browsers means that this function
5275 * actually just returns array() unconditionally at the moment. May as
5276 * well keep it around for when the browser bugs get fixed, though.
5278 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
5280 * @deprecated since 1.27
5281 * @return array Array of HTML attributes suitable for feeding to
5282 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
5283 * That will get confused by the boolean attribute syntax used.)
5285 public static function passwordChangeInputAttribs() {
5286 global $wgMinimalPasswordLength;
5288 if ( $wgMinimalPasswordLength == 0 ) {
5292 # Note that the pattern requirement will always be satisfied if the
5293 # input is empty, so we need required in all cases.
5295 # @todo FIXME: Bug 23769: This needs to not claim the password is required
5296 # if e-mail confirmation is being used. Since HTML5 input validation
5297 # is b0rked anyway in some browsers, just return nothing. When it's
5298 # re-enabled, fix this code to not output required for e-mail
5300 # $ret = array( 'required' );
5303 # We can't actually do this right now, because Opera 9.6 will print out
5304 # the entered password visibly in its error message! When other
5305 # browsers add support for this attribute, or Opera fixes its support,
5306 # we can add support with a version check to avoid doing this on Opera
5307 # versions where it will be a problem. Reported to Opera as
5308 # DSK-262266, but they don't have a public bug tracker for us to follow.
5310 if ( $wgMinimalPasswordLength > 1 ) {
5311 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
5312 $ret['title'] = wfMessage( 'passwordtooshort' )
5313 ->numParams( $wgMinimalPasswordLength )->text();
5321 * Return the list of user fields that should be selected to create
5322 * a new user object.
5325 public static function selectFields() {
5333 'user_email_authenticated',
5335 'user_email_token_expires',
5336 'user_registration',
5342 * Factory function for fatal permission-denied errors
5345 * @param string $permission User right required
5348 static function newFatalPermissionDeniedStatus( $permission ) {
5351 $groups = array_map(
5352 [ 'User', 'makeGroupLinkWiki' ],
5353 User
::getGroupsWithPermission( $permission )
5357 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5359 return Status
::newFatal( 'badaccess-group0' );
5364 * Get a new instance of this user that was loaded from the master via a locking read
5366 * Use this instead of the main context User when updating that user. This avoids races
5367 * where that user was loaded from a replica DB or even the master but without proper locks.
5369 * @return User|null Returns null if the user was not found in the DB
5372 public function getInstanceForUpdate() {
5373 if ( !$this->getId() ) {
5374 return null; // anon
5377 $user = self
::newFromId( $this->getId() );
5378 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5386 * Checks if two user objects point to the same user.
5392 public function equals( User
$user ) {
5393 return $this->getName() === $user->getName();