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
;
31 * String Some punctuation to prevent editing from broken text-mangling proxies.
32 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
35 define( 'EDIT_TOKEN_SUFFIX', Token
::SUFFIX
);
38 * The User object encapsulates all of the user-specific settings (user_id,
39 * name, rights, email address, options, last login time). Client
40 * classes use the getXXX() functions to access these fields. These functions
41 * do all the work of determining whether the user is logged in,
42 * whether the requested option can be satisfied from cookies or
43 * whether a database query is needed. Most of the settings needed
44 * for rendering normal pages are set in the cookie to minimize use
47 class User
implements IDBAccessObject
{
49 * @const int Number of characters in user_token field.
51 const TOKEN_LENGTH
= 32;
54 * @const string An invalid value for user_token
56 const INVALID_TOKEN
= '*** INVALID ***';
59 * Global constant made accessible as class constants so that autoloader
61 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
63 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
66 * @const int Serialized record version.
71 * Exclude user options that are set to their default value.
74 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
79 const CHECK_USER_RIGHTS
= true;
84 const IGNORE_USER_RIGHTS
= false;
87 * Array of Strings List of member variables which are saved to the
88 * shared cache (memcached). Any operation which changes the
89 * corresponding database fields must call a cache-clearing function.
92 protected static $mCacheVars = [
100 'mEmailAuthenticated',
102 'mEmailTokenExpires',
107 // user_properties table
112 * Array of Strings Core rights.
113 * Each of these should have a corresponding message of the form
117 protected static $mCoreRights = [
148 'editusercssjs', # deprecated
161 'move-categorypages',
162 'move-rootuserpages',
166 'override-export-depth',
189 'userrights-interwiki',
197 * String Cached results of getAllRights()
199 protected static $mAllRights = false;
201 /** Cache variables */
212 /** @var string TS_MW timestamp from the DB */
214 /** @var string TS_MW timestamp from cache */
215 protected $mQuickTouched;
219 public $mEmailAuthenticated;
221 protected $mEmailToken;
223 protected $mEmailTokenExpires;
225 protected $mRegistration;
227 protected $mEditCount;
231 protected $mOptionOverrides;
235 * Bool Whether the cache variables have been loaded.
238 public $mOptionsLoaded;
241 * Array with already loaded items or true if all items have been loaded.
243 protected $mLoadedItems = [];
247 * String Initialization data source if mLoadedItems!==true. May be one of:
248 * - 'defaults' anonymous user initialised from class defaults
249 * - 'name' initialise from mName
250 * - 'id' initialise from mId
251 * - 'session' log in from session if possible
253 * Use the User::newFrom*() family of functions to set this.
258 * Lazy-initialized variables, invalidated with clearInstanceCache
262 protected $mDatePreference;
270 protected $mBlockreason;
272 protected $mEffectiveGroups;
274 protected $mImplicitGroups;
276 protected $mFormerGroups;
278 protected $mGlobalBlock;
295 protected $mAllowUsertalk;
298 private $mBlockedFromCreateAccount = false;
300 /** @var integer User::READ_* constant bitfield used to load data */
301 protected $queryFlagsUsed = self
::READ_NORMAL
;
303 public static $idCacheByName = [];
306 * Lightweight constructor for an anonymous user.
307 * Use the User::newFrom* factory functions for other kinds of users.
311 * @see newFromConfirmationCode()
312 * @see newFromSession()
315 public function __construct() {
316 $this->clearInstanceCache( 'defaults' );
322 public function __toString() {
323 return $this->getName();
327 * Test if it's safe to load this User object.
329 * You should typically check this before using $wgUser or
330 * RequestContext::getUser in a method that might be called before the
331 * system has been fully initialized. If the object is unsafe, you should
332 * use an anonymous user:
334 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
340 public function isSafeToLoad() {
341 global $wgFullyInitialised;
343 // The user is safe to load if:
344 // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
345 // * mLoadedItems === true (already loaded)
346 // * mFrom !== 'session' (sessions not involved at all)
348 return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
349 $this->mLoadedItems
=== true ||
$this->mFrom
!== 'session';
353 * Load the user table data for this object from the source given by mFrom.
355 * @param integer $flags User::READ_* constant bitfield
357 public function load( $flags = self
::READ_NORMAL
) {
358 global $wgFullyInitialised;
360 if ( $this->mLoadedItems
=== true ) {
364 // Set it now to avoid infinite recursion in accessors
365 $oldLoadedItems = $this->mLoadedItems
;
366 $this->mLoadedItems
= true;
367 $this->queryFlagsUsed
= $flags;
369 // If this is called too early, things are likely to break.
370 if ( !$wgFullyInitialised && $this->mFrom
=== 'session' ) {
371 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
372 ->warning( 'User::loadFromSession called before the end of Setup.php', [
373 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
375 $this->loadDefaults();
376 $this->mLoadedItems
= $oldLoadedItems;
380 switch ( $this->mFrom
) {
382 $this->loadDefaults();
385 // Make sure this thread sees its own changes
386 if ( wfGetLB()->hasOrMadeRecentMasterChanges() ) {
387 $flags |
= self
::READ_LATEST
;
388 $this->queryFlagsUsed
= $flags;
391 $this->mId
= self
::idFromName( $this->mName
, $flags );
393 // Nonexistent user placeholder object
394 $this->loadDefaults( $this->mName
);
396 $this->loadFromId( $flags );
400 $this->loadFromId( $flags );
403 if ( !$this->loadFromSession() ) {
404 // Loading from session failed. Load defaults.
405 $this->loadDefaults();
407 Hooks
::run( 'UserLoadAfterLoadFromSession', [ $this ] );
410 throw new UnexpectedValueException(
411 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
416 * Load user table data, given mId has already been set.
417 * @param integer $flags User::READ_* constant bitfield
418 * @return bool False if the ID does not exist, true otherwise
420 public function loadFromId( $flags = self
::READ_NORMAL
) {
421 if ( $this->mId
== 0 ) {
422 // Anonymous users are not in the database (don't need cache)
423 $this->loadDefaults();
427 // Try cache (unless this needs data from the master DB).
428 // NOTE: if this thread called saveSettings(), the cache was cleared.
429 $latest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
431 if ( !$this->loadFromDatabase( $flags ) ) {
432 // Can't load from ID
436 $this->loadFromCache();
439 $this->mLoadedItems
= true;
440 $this->queryFlagsUsed
= $flags;
447 * @param string $wikiId
448 * @param integer $userId
450 public static function purge( $wikiId, $userId ) {
451 $cache = ObjectCache
::getMainWANInstance();
452 $key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
453 $cache->delete( $key );
458 * @param WANObjectCache $cache
461 protected function getCacheKey( WANObjectCache
$cache ) {
462 return $cache->makeGlobalKey( 'user', 'id', wfWikiID(), $this->mId
);
466 * Load user data from shared cache, given mId has already been set.
471 protected function loadFromCache() {
472 $cache = ObjectCache
::getMainWANInstance();
473 $data = $cache->getWithSetCallback(
474 $this->getCacheKey( $cache ),
476 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
477 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
478 wfDebug( "User: cache miss for user {$this->mId}\n" );
480 $this->loadFromDatabase( self
::READ_NORMAL
);
482 $this->loadOptions();
485 foreach ( self
::$mCacheVars as $name ) {
486 $data[$name] = $this->$name;
489 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->mTouched
), $ttl );
494 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'version' => self
::VERSION
]
497 // Restore from cache
498 foreach ( self
::$mCacheVars as $name ) {
499 $this->$name = $data[$name];
505 /** @name newFrom*() static factory methods */
509 * Static factory method for creation from username.
511 * This is slightly less efficient than newFromId(), so use newFromId() if
512 * you have both an ID and a name handy.
514 * @param string $name Username, validated by Title::newFromText()
515 * @param string|bool $validate Validate username. Takes the same parameters as
516 * User::getCanonicalName(), except that true is accepted as an alias
517 * for 'valid', for BC.
519 * @return User|bool User object, or false if the username is invalid
520 * (e.g. if it contains illegal characters or is an IP address). If the
521 * username is not present in the database, the result will be a user object
522 * with a name, zero user ID and default settings.
524 public static function newFromName( $name, $validate = 'valid' ) {
525 if ( $validate === true ) {
528 $name = self
::getCanonicalName( $name, $validate );
529 if ( $name === false ) {
532 // Create unloaded user object
536 $u->setItemLoaded( 'name' );
542 * Static factory method for creation from a given user ID.
544 * @param int $id Valid user ID
545 * @return User The corresponding User object
547 public static function newFromId( $id ) {
551 $u->setItemLoaded( 'id' );
556 * Factory method to fetch whichever user has a given email confirmation code.
557 * This code is generated when an account is created or its e-mail address
560 * If the code is invalid or has expired, returns NULL.
562 * @param string $code Confirmation code
563 * @param int $flags User::READ_* bitfield
566 public static function newFromConfirmationCode( $code, $flags = 0 ) {
567 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
568 ?
wfGetDB( DB_MASTER
)
569 : wfGetDB( DB_REPLICA
);
571 $id = $db->selectField(
575 'user_email_token' => md5( $code ),
576 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
580 return $id ? User
::newFromId( $id ) : null;
584 * Create a new user object using data from session. If the login
585 * credentials are invalid, the result is an anonymous user.
587 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
590 public static function newFromSession( WebRequest
$request = null ) {
592 $user->mFrom
= 'session';
593 $user->mRequest
= $request;
598 * Create a new user object from a user row.
599 * The row should have the following fields from the user table in it:
600 * - either user_name or user_id to load further data if needed (or both)
602 * - all other fields (email, etc.)
603 * It is useless to provide the remaining fields if either user_id,
604 * user_name and user_real_name are not provided because the whole row
605 * will be loaded once more from the database when accessing them.
607 * @param stdClass $row A row from the user table
608 * @param array $data Further data to load into the object (see User::loadFromRow for valid keys)
611 public static function newFromRow( $row, $data = null ) {
613 $user->loadFromRow( $row, $data );
618 * Static factory method for creation of a "system" user from username.
620 * A "system" user is an account that's used to attribute logged actions
621 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
622 * might include the 'Maintenance script' or 'Conversion script' accounts
623 * used by various scripts in the maintenance/ directory or accounts such
624 * as 'MediaWiki message delivery' used by the MassMessage extension.
626 * This can optionally create the user if it doesn't exist, and "steal" the
627 * account if it does exist.
629 * "Stealing" an existing user is intended to make it impossible for normal
630 * authentication processes to use the account, effectively disabling the
631 * account for normal use:
632 * - Email is invalidated, to prevent account recovery by emailing a
633 * temporary password and to disassociate the account from the existing
635 * - The token is set to a magic invalid value, to kill existing sessions
636 * and to prevent $this->setToken() calls from resetting the token to a
638 * - SessionManager is instructed to prevent new sessions for the user, to
639 * do things like deauthorizing OAuth consumers.
640 * - AuthManager is instructed to revoke access, to invalidate or remove
641 * passwords and other credentials.
643 * @param string $name Username
644 * @param array $options Options are:
645 * - validate: As for User::getCanonicalName(), default 'valid'
646 * - create: Whether to create the user if it doesn't already exist, default true
647 * - steal: Whether to "disable" the account for normal use if it already
648 * exists, default false
652 public static function newSystemUser( $name, $options = [] ) {
654 'validate' => 'valid',
659 $name = self
::getCanonicalName( $name, $options['validate'] );
660 if ( $name === false ) {
664 $fields = self
::selectFields();
666 $dbw = wfGetDB( DB_MASTER
);
667 $row = $dbw->selectRow(
670 [ 'user_name' => $name ],
674 // No user. Create it?
675 return $options['create'] ? self
::createNew( $name ) : null;
677 $user = self
::newFromRow( $row );
679 // A user is considered to exist as a non-system user if it can
680 // authenticate, or has an email set, or has a non-invalid token.
681 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
682 AuthManager
::singleton()->userCanAuthenticate( $name )
684 // User exists. Steal it?
685 if ( !$options['steal'] ) {
689 AuthManager
::singleton()->revokeAccessForUser( $name );
691 $user->invalidateEmail();
692 $user->mToken
= self
::INVALID_TOKEN
;
693 $user->saveSettings();
694 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
703 * Get the username corresponding to a given user ID
704 * @param int $id User ID
705 * @return string|bool The corresponding username
707 public static function whoIs( $id ) {
708 return UserCache
::singleton()->getProp( $id, 'name' );
712 * Get the real name of a user given their user ID
714 * @param int $id User ID
715 * @return string|bool The corresponding user's real name
717 public static function whoIsReal( $id ) {
718 return UserCache
::singleton()->getProp( $id, 'real_name' );
722 * Get database id given a user name
723 * @param string $name Username
724 * @param integer $flags User::READ_* constant bitfield
725 * @return int|null The corresponding user's ID, or null if user is nonexistent
727 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
728 $nt = Title
::makeTitleSafe( NS_USER
, $name );
729 if ( is_null( $nt ) ) {
734 if ( !( $flags & self
::READ_LATEST
) && isset( self
::$idCacheByName[$name] ) ) {
735 return self
::$idCacheByName[$name];
738 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
739 $db = wfGetDB( $index );
744 [ 'user_name' => $nt->getText() ],
749 if ( $s === false ) {
752 $result = $s->user_id
;
755 self
::$idCacheByName[$name] = $result;
757 if ( count( self
::$idCacheByName ) > 1000 ) {
758 self
::$idCacheByName = [];
765 * Reset the cache used in idFromName(). For use in tests.
767 public static function resetIdByNameCache() {
768 self
::$idCacheByName = [];
772 * Does the string match an anonymous IP address?
774 * This function exists for username validation, in order to reject
775 * usernames which are similar in form to IP addresses. Strings such
776 * as 300.300.300.300 will return true because it looks like an IP
777 * address, despite not being strictly valid.
779 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
780 * address because the usemod software would "cloak" anonymous IP
781 * addresses like this, if we allowed accounts like this to be created
782 * new users could get the old edits of these anonymous users.
784 * @param string $name Name to match
787 public static function isIP( $name ) {
788 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
789 || IP
::isIPv6( $name );
793 * Is the input a valid username?
795 * Checks if the input is a valid username, we don't want an empty string,
796 * an IP address, anything that contains slashes (would mess up subpages),
797 * is longer than the maximum allowed username size or doesn't begin with
800 * @param string $name Name to match
803 public static function isValidUserName( $name ) {
804 global $wgContLang, $wgMaxNameChars;
807 || User
::isIP( $name )
808 ||
strpos( $name, '/' ) !== false
809 ||
strlen( $name ) > $wgMaxNameChars
810 ||
$name != $wgContLang->ucfirst( $name )
815 // Ensure that the name can't be misresolved as a different title,
816 // such as with extra namespace keys at the start.
817 $parsed = Title
::newFromText( $name );
818 if ( is_null( $parsed )
819 ||
$parsed->getNamespace()
820 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
824 // Check an additional blacklist of troublemaker characters.
825 // Should these be merged into the title char list?
826 $unicodeBlacklist = '/[' .
827 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
828 '\x{00a0}' . # non-breaking space
829 '\x{2000}-\x{200f}' . # various whitespace
830 '\x{2028}-\x{202f}' . # breaks and control chars
831 '\x{3000}' . # ideographic space
832 '\x{e000}-\x{f8ff}' . # private use
834 if ( preg_match( $unicodeBlacklist, $name ) ) {
842 * Usernames which fail to pass this function will be blocked
843 * from user login and new account registrations, but may be used
844 * internally by batch processes.
846 * If an account already exists in this form, login will be blocked
847 * by a failure to pass this function.
849 * @param string $name Name to match
852 public static function isUsableName( $name ) {
853 global $wgReservedUsernames;
854 // Must be a valid username, obviously ;)
855 if ( !self
::isValidUserName( $name ) ) {
859 static $reservedUsernames = false;
860 if ( !$reservedUsernames ) {
861 $reservedUsernames = $wgReservedUsernames;
862 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
865 // Certain names may be reserved for batch processes.
866 foreach ( $reservedUsernames as $reserved ) {
867 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
868 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
870 if ( $reserved == $name ) {
878 * Return the users who are members of the given group(s). In case of multiple groups,
879 * users who are members of at least one of them are returned.
881 * @param string|array $groups A single group name or an array of group names
882 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
883 * records; larger values are ignored.
884 * @param int $after ID the user to start after
885 * @return UserArrayFromResult
887 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
888 if ( $groups === [] ) {
889 return UserArrayFromResult
::newFromIDs( [] );
892 $groups = array_unique( (array)$groups );
893 $limit = min( 5000, $limit );
895 $conds = [ 'ug_group' => $groups ];
896 if ( $after !== null ) {
897 $conds[] = 'ug_user > ' . (int)$after;
900 $dbr = wfGetDB( DB_REPLICA
);
901 $ids = $dbr->selectFieldValues(
908 'ORDER BY' => 'ug_user',
912 return UserArray
::newFromIDs( $ids );
916 * Usernames which fail to pass this function will be blocked
917 * from new account registrations, but may be used internally
918 * either by batch processes or by user accounts which have
919 * already been created.
921 * Additional blacklisting may be added here rather than in
922 * isValidUserName() to avoid disrupting existing accounts.
924 * @param string $name String to match
927 public static function isCreatableName( $name ) {
928 global $wgInvalidUsernameCharacters;
930 // Ensure that the username isn't longer than 235 bytes, so that
931 // (at least for the builtin skins) user javascript and css files
932 // will work. (bug 23080)
933 if ( strlen( $name ) > 235 ) {
934 wfDebugLog( 'username', __METHOD__
.
935 ": '$name' invalid due to length" );
939 // Preg yells if you try to give it an empty string
940 if ( $wgInvalidUsernameCharacters !== '' ) {
941 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
942 wfDebugLog( 'username', __METHOD__
.
943 ": '$name' invalid due to wgInvalidUsernameCharacters" );
948 return self
::isUsableName( $name );
952 * Is the input a valid password for this user?
954 * @param string $password Desired password
957 public function isValidPassword( $password ) {
958 // simple boolean wrapper for getPasswordValidity
959 return $this->getPasswordValidity( $password ) === true;
963 * Given unvalidated password input, return error message on failure.
965 * @param string $password Desired password
966 * @return bool|string|array True on success, string or array of error message on failure
968 public function getPasswordValidity( $password ) {
969 $result = $this->checkPasswordValidity( $password );
970 if ( $result->isGood() ) {
974 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
975 $messages[] = $error['message'];
977 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
978 $messages[] = $warning['message'];
980 if ( count( $messages ) === 1 ) {
988 * Check if this is a valid password for this user
990 * Create a Status object based on the password's validity.
991 * The Status should be set to fatal if the user should not
992 * be allowed to log in, and should have any errors that
993 * would block changing the password.
995 * If the return value of this is not OK, the password
996 * should not be checked. If the return value is not Good,
997 * the password can be checked, but the user should not be
998 * able to set their password to this.
1000 * @param string $password Desired password
1001 * @param string $purpose one of 'login', 'create', 'reset'
1005 public function checkPasswordValidity( $password, $purpose = 'login' ) {
1006 global $wgPasswordPolicy;
1008 $upp = new UserPasswordPolicy(
1009 $wgPasswordPolicy['policies'],
1010 $wgPasswordPolicy['checks']
1013 $status = Status
::newGood();
1014 $result = false; // init $result to false for the internal checks
1016 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1017 $status->error( $result );
1021 if ( $result === false ) {
1022 $status->merge( $upp->checkUserPassword( $this, $password, $purpose ) );
1024 } elseif ( $result === true ) {
1027 $status->error( $result );
1028 return $status; // the isValidPassword hook set a string $result and returned true
1033 * Given unvalidated user input, return a canonical username, or false if
1034 * the username is invalid.
1035 * @param string $name User input
1036 * @param string|bool $validate Type of validation to use:
1037 * - false No validation
1038 * - 'valid' Valid for batch processes
1039 * - 'usable' Valid for batch processes and login
1040 * - 'creatable' Valid for batch processes, login and account creation
1042 * @throws InvalidArgumentException
1043 * @return bool|string
1045 public static function getCanonicalName( $name, $validate = 'valid' ) {
1046 // Force usernames to capital
1048 $name = $wgContLang->ucfirst( $name );
1050 # Reject names containing '#'; these will be cleaned up
1051 # with title normalisation, but then it's too late to
1053 if ( strpos( $name, '#' ) !== false ) {
1057 // Clean up name according to title rules,
1058 // but only when validation is requested (bug 12654)
1059 $t = ( $validate !== false ) ?
1060 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1061 // Check for invalid titles
1062 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1066 // Reject various classes of invalid names
1067 $name = AuthManager
::callLegacyAuthPlugin(
1068 'getCanonicalName', [ $t->getText() ], $t->getText()
1071 switch ( $validate ) {
1075 if ( !User
::isValidUserName( $name ) ) {
1080 if ( !User
::isUsableName( $name ) ) {
1085 if ( !User
::isCreatableName( $name ) ) {
1090 throw new InvalidArgumentException(
1091 'Invalid parameter value for $validate in ' . __METHOD__
);
1097 * Count the number of edits of a user
1099 * @param int $uid User ID to check
1100 * @return int The user's edit count
1102 * @deprecated since 1.21 in favour of User::getEditCount
1104 public static function edits( $uid ) {
1105 wfDeprecated( __METHOD__
, '1.21' );
1106 $user = self
::newFromId( $uid );
1107 return $user->getEditCount();
1111 * Return a random password.
1113 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1114 * @return string New random password
1116 public static function randomPassword() {
1117 global $wgMinimalPasswordLength;
1118 return PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1122 * Set cached properties to default.
1124 * @note This no longer clears uncached lazy-initialised properties;
1125 * the constructor does that instead.
1127 * @param string|bool $name
1129 public function loadDefaults( $name = false ) {
1131 $this->mName
= $name;
1132 $this->mRealName
= '';
1134 $this->mOptionOverrides
= null;
1135 $this->mOptionsLoaded
= false;
1137 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1138 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1139 if ( $loggedOut !== 0 ) {
1140 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1142 $this->mTouched
= '1'; # Allow any pages to be cached
1145 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1146 $this->mEmailAuthenticated
= null;
1147 $this->mEmailToken
= '';
1148 $this->mEmailTokenExpires
= null;
1149 $this->mRegistration
= wfTimestamp( TS_MW
);
1150 $this->mGroups
= [];
1152 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1156 * Return whether an item has been loaded.
1158 * @param string $item Item to check. Current possibilities:
1162 * @param string $all 'all' to check if the whole object has been loaded
1163 * or any other string to check if only the item is available (e.g.
1167 public function isItemLoaded( $item, $all = 'all' ) {
1168 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1169 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1173 * Set that an item has been loaded
1175 * @param string $item
1177 protected function setItemLoaded( $item ) {
1178 if ( is_array( $this->mLoadedItems
) ) {
1179 $this->mLoadedItems
[$item] = true;
1184 * Load user data from the session.
1186 * @return bool True if the user is logged in, false otherwise.
1188 private function loadFromSession() {
1191 Hooks
::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1192 if ( $result !== null ) {
1196 // MediaWiki\Session\Session already did the necessary authentication of the user
1197 // returned here, so just use it if applicable.
1198 $session = $this->getRequest()->getSession();
1199 $user = $session->getUser();
1200 if ( $user->isLoggedIn() ) {
1201 $this->loadFromUserObject( $user );
1202 // Other code expects these to be set in the session, so set them.
1203 $session->set( 'wsUserID', $this->getId() );
1204 $session->set( 'wsUserName', $this->getName() );
1205 $session->set( 'wsToken', $this->getToken() );
1213 * Load user and user_group data from the database.
1214 * $this->mId must be set, this is how the user is identified.
1216 * @param integer $flags User::READ_* constant bitfield
1217 * @return bool True if the user exists, false if the user is anonymous
1219 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1221 $this->mId
= intval( $this->mId
);
1223 if ( !$this->mId
) {
1224 // Anonymous users are not in the database
1225 $this->loadDefaults();
1229 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1230 $db = wfGetDB( $index );
1232 $s = $db->selectRow(
1234 self
::selectFields(),
1235 [ 'user_id' => $this->mId
],
1240 $this->queryFlagsUsed
= $flags;
1241 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1243 if ( $s !== false ) {
1244 // Initialise user table data
1245 $this->loadFromRow( $s );
1246 $this->mGroups
= null; // deferred
1247 $this->getEditCount(); // revalidation for nulls
1252 $this->loadDefaults();
1258 * Initialize this object from a row from the user table.
1260 * @param stdClass $row Row from the user table to load.
1261 * @param array $data Further user data to load into the object
1263 * user_groups Array with groups out of the user_groups table
1264 * user_properties Array with properties out of the user_properties table
1266 protected function loadFromRow( $row, $data = null ) {
1269 $this->mGroups
= null; // deferred
1271 if ( isset( $row->user_name
) ) {
1272 $this->mName
= $row->user_name
;
1273 $this->mFrom
= 'name';
1274 $this->setItemLoaded( 'name' );
1279 if ( isset( $row->user_real_name
) ) {
1280 $this->mRealName
= $row->user_real_name
;
1281 $this->setItemLoaded( 'realname' );
1286 if ( isset( $row->user_id
) ) {
1287 $this->mId
= intval( $row->user_id
);
1288 $this->mFrom
= 'id';
1289 $this->setItemLoaded( 'id' );
1294 if ( isset( $row->user_id
) && isset( $row->user_name
) ) {
1295 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1298 if ( isset( $row->user_editcount
) ) {
1299 $this->mEditCount
= $row->user_editcount
;
1304 if ( isset( $row->user_touched
) ) {
1305 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1310 if ( isset( $row->user_token
) ) {
1311 // The definition for the column is binary(32), so trim the NULs
1312 // that appends. The previous definition was char(32), so trim
1314 $this->mToken
= rtrim( $row->user_token
, " \0" );
1315 if ( $this->mToken
=== '' ) {
1316 $this->mToken
= null;
1322 if ( isset( $row->user_email
) ) {
1323 $this->mEmail
= $row->user_email
;
1324 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1325 $this->mEmailToken
= $row->user_email_token
;
1326 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1327 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1333 $this->mLoadedItems
= true;
1336 if ( is_array( $data ) ) {
1337 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1338 $this->mGroups
= $data['user_groups'];
1340 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1341 $this->loadOptions( $data['user_properties'] );
1347 * Load the data for this user object from another user object.
1351 protected function loadFromUserObject( $user ) {
1353 foreach ( self
::$mCacheVars as $var ) {
1354 $this->$var = $user->$var;
1359 * Load the groups from the database if they aren't already loaded.
1361 private function loadGroups() {
1362 if ( is_null( $this->mGroups
) ) {
1363 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1364 ?
wfGetDB( DB_MASTER
)
1365 : wfGetDB( DB_REPLICA
);
1366 $res = $db->select( 'user_groups',
1368 [ 'ug_user' => $this->mId
],
1370 $this->mGroups
= [];
1371 foreach ( $res as $row ) {
1372 $this->mGroups
[] = $row->ug_group
;
1378 * Add the user to the group if he/she meets given criteria.
1380 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1381 * possible to remove manually via Special:UserRights. In such case it
1382 * will not be re-added automatically. The user will also not lose the
1383 * group if they no longer meet the criteria.
1385 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1387 * @return array Array of groups the user has been promoted to.
1389 * @see $wgAutopromoteOnce
1391 public function addAutopromoteOnceGroups( $event ) {
1392 global $wgAutopromoteOnceLogInRC;
1394 if ( wfReadOnly() ||
!$this->getId() ) {
1398 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1399 if ( !count( $toPromote ) ) {
1403 if ( !$this->checkAndSetTouched() ) {
1404 return []; // raced out (bug T48834)
1407 $oldGroups = $this->getGroups(); // previous groups
1408 foreach ( $toPromote as $group ) {
1409 $this->addGroup( $group );
1411 // update groups in external authentication database
1412 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false ] );
1413 AuthManager
::callLegacyAuthPlugin( 'updateExternalDBGroups', [ $this, $toPromote ] );
1415 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1417 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1418 $logEntry->setPerformer( $this );
1419 $logEntry->setTarget( $this->getUserPage() );
1420 $logEntry->setParameters( [
1421 '4::oldgroups' => $oldGroups,
1422 '5::newgroups' => $newGroups,
1424 $logid = $logEntry->insert();
1425 if ( $wgAutopromoteOnceLogInRC ) {
1426 $logEntry->publish( $logid );
1433 * Builds update conditions. Additional conditions may be added to $conditions to
1434 * protected against race conditions using a compare-and-set (CAS) mechanism
1435 * based on comparing $this->mTouched with the user_touched field.
1437 * @param DatabaseBase $db
1438 * @param array $conditions WHERE conditions for use with DatabaseBase::update
1439 * @return array WHERE conditions for use with DatabaseBase::update
1441 protected function makeUpdateConditions( DatabaseBase
$db, array $conditions ) {
1442 if ( $this->mTouched
) {
1443 // CAS check: only update if the row wasn't changed sicne it was loaded.
1444 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1451 * Bump user_touched if it didn't change since this object was loaded
1453 * On success, the mTouched field is updated.
1454 * The user serialization cache is always cleared.
1456 * @return bool Whether user_touched was actually updated
1459 protected function checkAndSetTouched() {
1462 if ( !$this->mId
) {
1463 return false; // anon
1466 // Get a new user_touched that is higher than the old one
1467 $newTouched = $this->newTouchedTimestamp();
1469 $dbw = wfGetDB( DB_MASTER
);
1470 $dbw->update( 'user',
1471 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1472 $this->makeUpdateConditions( $dbw, [
1473 'user_id' => $this->mId
,
1477 $success = ( $dbw->affectedRows() > 0 );
1480 $this->mTouched
= $newTouched;
1481 $this->clearSharedCache();
1483 // Clears on failure too since that is desired if the cache is stale
1484 $this->clearSharedCache( 'refresh' );
1491 * Clear various cached data stored in this object. The cache of the user table
1492 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1494 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1495 * given source. May be "name", "id", "defaults", "session", or false for no reload.
1497 public function clearInstanceCache( $reloadFrom = false ) {
1498 $this->mNewtalk
= -1;
1499 $this->mDatePreference
= null;
1500 $this->mBlockedby
= -1; # Unset
1501 $this->mHash
= false;
1502 $this->mRights
= null;
1503 $this->mEffectiveGroups
= null;
1504 $this->mImplicitGroups
= null;
1505 $this->mGroups
= null;
1506 $this->mOptions
= null;
1507 $this->mOptionsLoaded
= false;
1508 $this->mEditCount
= null;
1510 if ( $reloadFrom ) {
1511 $this->mLoadedItems
= [];
1512 $this->mFrom
= $reloadFrom;
1517 * Combine the language default options with any site-specific options
1518 * and add the default language variants.
1520 * @return array Array of String options
1522 public static function getDefaultOptions() {
1523 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1525 static $defOpt = null;
1526 static $defOptLang = null;
1528 if ( $defOpt !== null && $defOptLang === $wgContLang->getCode() ) {
1529 // $wgContLang does not change (and should not change) mid-request,
1530 // but the unit tests change it anyway, and expect this method to
1531 // return values relevant to the current $wgContLang.
1535 $defOpt = $wgDefaultUserOptions;
1536 // Default language setting
1537 $defOptLang = $wgContLang->getCode();
1538 $defOpt['language'] = $defOptLang;
1539 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1540 $defOpt[$langCode == $wgContLang->getCode() ?
'variant' : "variant-$langCode"] = $langCode;
1543 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1544 // since extensions may change the set of searchable namespaces depending
1545 // on user groups/permissions.
1546 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1547 $defOpt['searchNs' . $nsnum] = (boolean
)$val;
1549 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1551 Hooks
::run( 'UserGetDefaultOptions', [ &$defOpt ] );
1557 * Get a given default option value.
1559 * @param string $opt Name of option to retrieve
1560 * @return string Default option value
1562 public static function getDefaultOption( $opt ) {
1563 $defOpts = self
::getDefaultOptions();
1564 if ( isset( $defOpts[$opt] ) ) {
1565 return $defOpts[$opt];
1572 * Get blocking information
1573 * @param bool $bFromSlave Whether to check the replica DB first.
1574 * To improve performance, non-critical checks are done against replica DBs.
1575 * Check when actually saving should be done against master.
1577 private function getBlockedStatus( $bFromSlave = true ) {
1578 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff;
1580 if ( -1 != $this->mBlockedby
) {
1584 wfDebug( __METHOD__
. ": checking...\n" );
1586 // Initialize data...
1587 // Otherwise something ends up stomping on $this->mBlockedby when
1588 // things get lazy-loaded later, causing false positive block hits
1589 // due to -1 !== 0. Probably session-related... Nothing should be
1590 // overwriting mBlockedby, surely?
1593 # We only need to worry about passing the IP address to the Block generator if the
1594 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1595 # know which IP address they're actually coming from
1597 if ( !$this->isAllowed( 'ipblock-exempt' ) ) {
1598 // $wgUser->getName() only works after the end of Setup.php. Until
1599 // then, assume it's a logged-out user.
1600 $globalUserName = $wgUser->isSafeToLoad()
1601 ?
$wgUser->getName()
1602 : IP
::sanitizeIP( $wgUser->getRequest()->getIP() );
1603 if ( $this->getName() === $globalUserName ) {
1604 $ip = $this->getRequest()->getIP();
1609 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1612 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1614 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1616 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1617 $block->mReason
= wfMessage( 'proxyblockreason' )->text();
1618 $block->setTarget( $ip );
1619 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1621 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1622 $block->mReason
= wfMessage( 'sorbsreason' )->text();
1623 $block->setTarget( $ip );
1627 // (bug 23343) Apply IP blocks to the contents of XFF headers, if enabled
1628 if ( !$block instanceof Block
1629 && $wgApplyIpBlocksToXff
1631 && !in_array( $ip, $wgProxyWhitelist )
1633 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1634 $xff = array_map( 'trim', explode( ',', $xff ) );
1635 $xff = array_diff( $xff, [ $ip ] );
1636 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1637 $block = Block
::chooseBlock( $xffblocks, $xff );
1638 if ( $block instanceof Block
) {
1639 # Mangle the reason to alert the user that the block
1640 # originated from matching the X-Forwarded-For header.
1641 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->text();
1645 if ( $block instanceof Block
) {
1646 wfDebug( __METHOD__
. ": Found block.\n" );
1647 $this->mBlock
= $block;
1648 $this->mBlockedby
= $block->getByName();
1649 $this->mBlockreason
= $block->mReason
;
1650 $this->mHideName
= $block->mHideName
;
1651 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1653 $this->mBlockedby
= '';
1654 $this->mHideName
= 0;
1655 $this->mAllowUsertalk
= false;
1659 Hooks
::run( 'GetBlockedStatus', [ &$this ] );
1664 * Whether the given IP is in a DNS blacklist.
1666 * @param string $ip IP to check
1667 * @param bool $checkWhitelist Whether to check the whitelist first
1668 * @return bool True if blacklisted.
1670 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1671 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1673 if ( !$wgEnableDnsBlacklist ) {
1677 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1681 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
1685 * Whether the given IP is in a given DNS blacklist.
1687 * @param string $ip IP to check
1688 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1689 * @return bool True if blacklisted.
1691 public function inDnsBlacklist( $ip, $bases ) {
1694 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1695 if ( IP
::isIPv4( $ip ) ) {
1696 // Reverse IP, bug 21255
1697 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1699 foreach ( (array)$bases as $base ) {
1701 // If we have an access key, use that too (ProjectHoneypot, etc.)
1703 if ( is_array( $base ) ) {
1704 if ( count( $base ) >= 2 ) {
1705 // Access key is 1, base URL is 0
1706 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1708 $host = "$ipReversed.{$base[0]}";
1710 $basename = $base[0];
1712 $host = "$ipReversed.$base";
1716 $ipList = gethostbynamel( $host );
1719 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
1723 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
1732 * Check if an IP address is in the local proxy list
1738 public static function isLocallyBlockedProxy( $ip ) {
1739 global $wgProxyList;
1741 if ( !$wgProxyList ) {
1745 if ( !is_array( $wgProxyList ) ) {
1746 // Load from the specified file
1747 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1750 if ( !is_array( $wgProxyList ) ) {
1752 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1754 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1755 // Old-style flipped proxy list
1764 * Is this user subject to rate limiting?
1766 * @return bool True if rate limited
1768 public function isPingLimitable() {
1769 global $wgRateLimitsExcludedIPs;
1770 if ( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1771 // No other good way currently to disable rate limits
1772 // for specific IPs. :P
1773 // But this is a crappy hack and should die.
1776 return !$this->isAllowed( 'noratelimit' );
1780 * Primitive rate limits: enforce maximum actions per time period
1781 * to put a brake on flooding.
1783 * The method generates both a generic profiling point and a per action one
1784 * (suffix being "-$action".
1786 * @note When using a shared cache like memcached, IP-address
1787 * last-hit counters will be shared across wikis.
1789 * @param string $action Action to enforce; 'edit' if unspecified
1790 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1791 * @return bool True if a rate limiter was tripped
1793 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1794 // Call the 'PingLimiter' hook
1796 if ( !Hooks
::run( 'PingLimiter', [ &$this, $action, &$result, $incrBy ] ) ) {
1800 global $wgRateLimits;
1801 if ( !isset( $wgRateLimits[$action] ) ) {
1805 // Some groups shouldn't trigger the ping limiter, ever
1806 if ( !$this->isPingLimitable() ) {
1810 $limits = $wgRateLimits[$action];
1812 $id = $this->getId();
1814 $isNewbie = $this->isNewbie();
1818 if ( isset( $limits['anon'] ) ) {
1819 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1822 // limits for logged-in users
1823 if ( isset( $limits['user'] ) ) {
1824 $userLimit = $limits['user'];
1826 // limits for newbie logged-in users
1827 if ( $isNewbie && isset( $limits['newbie'] ) ) {
1828 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1832 // limits for anons and for newbie logged-in users
1835 if ( isset( $limits['ip'] ) ) {
1836 $ip = $this->getRequest()->getIP();
1837 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1839 // subnet-based limits
1840 if ( isset( $limits['subnet'] ) ) {
1841 $ip = $this->getRequest()->getIP();
1842 $subnet = IP
::getSubnet( $ip );
1843 if ( $subnet !== false ) {
1844 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1849 // Check for group-specific permissions
1850 // If more than one group applies, use the group with the highest limit ratio (max/period)
1851 foreach ( $this->getGroups() as $group ) {
1852 if ( isset( $limits[$group] ) ) {
1853 if ( $userLimit === false
1854 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
1856 $userLimit = $limits[$group];
1861 // Set the user limit key
1862 if ( $userLimit !== false ) {
1863 list( $max, $period ) = $userLimit;
1864 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
1865 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $userLimit;
1868 // ip-based limits for all ping-limitable users
1869 if ( isset( $limits['ip-all'] ) ) {
1870 $ip = $this->getRequest()->getIP();
1871 // ignore if user limit is more permissive
1872 if ( $isNewbie ||
$userLimit === false
1873 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
1874 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
1878 // subnet-based limits for all ping-limitable users
1879 if ( isset( $limits['subnet-all'] ) ) {
1880 $ip = $this->getRequest()->getIP();
1881 $subnet = IP
::getSubnet( $ip );
1882 if ( $subnet !== false ) {
1883 // ignore if user limit is more permissive
1884 if ( $isNewbie ||
$userLimit === false
1885 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
1886 > $userLimit[0] / $userLimit[1] ) {
1887 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
1892 $cache = ObjectCache
::getLocalClusterInstance();
1895 foreach ( $keys as $key => $limit ) {
1896 list( $max, $period ) = $limit;
1897 $summary = "(limit $max in {$period}s)";
1898 $count = $cache->get( $key );
1901 if ( $count >= $max ) {
1902 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
1903 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
1906 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1909 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1910 if ( $incrBy > 0 ) {
1911 $cache->add( $key, 0, intval( $period ) ); // first ping
1914 if ( $incrBy > 0 ) {
1915 $cache->incr( $key, $incrBy );
1923 * Check if user is blocked
1925 * @param bool $bFromSlave Whether to check the replica DB instead of
1926 * the master. Hacked from false due to horrible probs on site.
1927 * @return bool True if blocked, false otherwise
1929 public function isBlocked( $bFromSlave = true ) {
1930 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1934 * Get the block affecting the user, or null if the user is not blocked
1936 * @param bool $bFromSlave Whether to check the replica DB instead of the master
1937 * @return Block|null
1939 public function getBlock( $bFromSlave = true ) {
1940 $this->getBlockedStatus( $bFromSlave );
1941 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1945 * Check if user is blocked from editing a particular article
1947 * @param Title $title Title to check
1948 * @param bool $bFromSlave Whether to check the replica DB instead of the master
1951 public function isBlockedFrom( $title, $bFromSlave = false ) {
1952 global $wgBlockAllowsUTEdit;
1954 $blocked = $this->isBlocked( $bFromSlave );
1955 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1956 // If a user's name is suppressed, they cannot make edits anywhere
1957 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName()
1958 && $title->getNamespace() == NS_USER_TALK
) {
1960 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1963 Hooks
::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
1969 * If user is blocked, return the name of the user who placed the block
1970 * @return string Name of blocker
1972 public function blockedBy() {
1973 $this->getBlockedStatus();
1974 return $this->mBlockedby
;
1978 * If user is blocked, return the specified reason for the block
1979 * @return string Blocking reason
1981 public function blockedFor() {
1982 $this->getBlockedStatus();
1983 return $this->mBlockreason
;
1987 * If user is blocked, return the ID for the block
1988 * @return int Block ID
1990 public function getBlockId() {
1991 $this->getBlockedStatus();
1992 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1996 * Check if user is blocked on all wikis.
1997 * Do not use for actual edit permission checks!
1998 * This is intended for quick UI checks.
2000 * @param string $ip IP address, uses current client if none given
2001 * @return bool True if blocked, false otherwise
2003 public function isBlockedGlobally( $ip = '' ) {
2004 return $this->getGlobalBlock( $ip ) instanceof Block
;
2008 * Check if user is blocked on all wikis.
2009 * Do not use for actual edit permission checks!
2010 * This is intended for quick UI checks.
2012 * @param string $ip IP address, uses current client if none given
2013 * @return Block|null Block object if blocked, null otherwise
2014 * @throws FatalError
2015 * @throws MWException
2017 public function getGlobalBlock( $ip = '' ) {
2018 if ( $this->mGlobalBlock
!== null ) {
2019 return $this->mGlobalBlock ?
: null;
2021 // User is already an IP?
2022 if ( IP
::isIPAddress( $this->getName() ) ) {
2023 $ip = $this->getName();
2025 $ip = $this->getRequest()->getIP();
2029 Hooks
::run( 'UserIsBlockedGlobally', [ &$this, $ip, &$blocked, &$block ] );
2031 if ( $blocked && $block === null ) {
2032 // back-compat: UserIsBlockedGlobally didn't have $block param first
2034 $block->setTarget( $ip );
2037 $this->mGlobalBlock
= $blocked ?
$block : false;
2038 return $this->mGlobalBlock ?
: null;
2042 * Check if user account is locked
2044 * @return bool True if locked, false otherwise
2046 public function isLocked() {
2047 if ( $this->mLocked
!== null ) {
2048 return $this->mLocked
;
2050 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$this ], null );
2051 $this->mLocked
= $authUser && $authUser->isLocked();
2052 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2053 return $this->mLocked
;
2057 * Check if user account is hidden
2059 * @return bool True if hidden, false otherwise
2061 public function isHidden() {
2062 if ( $this->mHideName
!== null ) {
2063 return $this->mHideName
;
2065 $this->getBlockedStatus();
2066 if ( !$this->mHideName
) {
2067 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$this ], null );
2068 $this->mHideName
= $authUser && $authUser->isHidden();
2069 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2071 return $this->mHideName
;
2075 * Get the user's ID.
2076 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2078 public function getId() {
2079 if ( $this->mId
=== null && $this->mName
!== null && User
::isIP( $this->mName
) ) {
2080 // Special case, we know the user is anonymous
2082 } elseif ( !$this->isItemLoaded( 'id' ) ) {
2083 // Don't load if this was initialized from an ID
2087 return (int)$this->mId
;
2091 * Set the user and reload all fields according to a given ID
2092 * @param int $v User ID to reload
2094 public function setId( $v ) {
2096 $this->clearInstanceCache( 'id' );
2100 * Get the user name, or the IP of an anonymous user
2101 * @return string User's name or IP address
2103 public function getName() {
2104 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2105 // Special case optimisation
2106 return $this->mName
;
2109 if ( $this->mName
=== false ) {
2111 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2113 return $this->mName
;
2118 * Set the user name.
2120 * This does not reload fields from the database according to the given
2121 * name. Rather, it is used to create a temporary "nonexistent user" for
2122 * later addition to the database. It can also be used to set the IP
2123 * address for an anonymous user to something other than the current
2126 * @note User::newFromName() has roughly the same function, when the named user
2128 * @param string $str New user name to set
2130 public function setName( $str ) {
2132 $this->mName
= $str;
2136 * Get the user's name escaped by underscores.
2137 * @return string Username escaped by underscores.
2139 public function getTitleKey() {
2140 return str_replace( ' ', '_', $this->getName() );
2144 * Check if the user has new messages.
2145 * @return bool True if the user has new messages
2147 public function getNewtalk() {
2150 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2151 if ( $this->mNewtalk
=== -1 ) {
2152 $this->mNewtalk
= false; # reset talk page status
2154 // Check memcached separately for anons, who have no
2155 // entire User object stored in there.
2156 if ( !$this->mId
) {
2157 global $wgDisableAnonTalk;
2158 if ( $wgDisableAnonTalk ) {
2159 // Anon newtalk disabled by configuration.
2160 $this->mNewtalk
= false;
2162 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2165 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2169 return (bool)$this->mNewtalk
;
2173 * Return the data needed to construct links for new talk page message
2174 * alerts. If there are new messages, this will return an associative array
2175 * with the following data:
2176 * wiki: The database name of the wiki
2177 * link: Root-relative link to the user's talk page
2178 * rev: The last talk page revision that the user has seen or null. This
2179 * is useful for building diff links.
2180 * If there are no new messages, it returns an empty array.
2181 * @note This function was designed to accomodate multiple talk pages, but
2182 * currently only returns a single link and revision.
2185 public function getNewMessageLinks() {
2187 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$this, &$talks ] ) ) {
2189 } elseif ( !$this->getNewtalk() ) {
2192 $utp = $this->getTalkPage();
2193 $dbr = wfGetDB( DB_REPLICA
);
2194 // Get the "last viewed rev" timestamp from the oldest message notification
2195 $timestamp = $dbr->selectField( 'user_newtalk',
2196 'MIN(user_last_timestamp)',
2197 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2199 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2200 return [ [ 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ] ];
2204 * Get the revision ID for the last talk page revision viewed by the talk
2206 * @return int|null Revision ID or null
2208 public function getNewMessageRevisionId() {
2209 $newMessageRevisionId = null;
2210 $newMessageLinks = $this->getNewMessageLinks();
2211 if ( $newMessageLinks ) {
2212 // Note: getNewMessageLinks() never returns more than a single link
2213 // and it is always for the same wiki, but we double-check here in
2214 // case that changes some time in the future.
2215 if ( count( $newMessageLinks ) === 1
2216 && $newMessageLinks[0]['wiki'] === wfWikiID()
2217 && $newMessageLinks[0]['rev']
2219 /** @var Revision $newMessageRevision */
2220 $newMessageRevision = $newMessageLinks[0]['rev'];
2221 $newMessageRevisionId = $newMessageRevision->getId();
2224 return $newMessageRevisionId;
2228 * Internal uncached check for new messages
2231 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2232 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2233 * @return bool True if the user has new messages
2235 protected function checkNewtalk( $field, $id ) {
2236 $dbr = wfGetDB( DB_REPLICA
);
2238 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2240 return $ok !== false;
2244 * Add or update the new messages flag
2245 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2246 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2247 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2248 * @return bool True if successful, false otherwise
2250 protected function updateNewtalk( $field, $id, $curRev = null ) {
2251 // Get timestamp of the talk page revision prior to the current one
2252 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2253 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2254 // Mark the user as having new messages since this revision
2255 $dbw = wfGetDB( DB_MASTER
);
2256 $dbw->insert( 'user_newtalk',
2257 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2260 if ( $dbw->affectedRows() ) {
2261 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2264 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2270 * Clear the new messages flag for the given user
2271 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2272 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2273 * @return bool True if successful, false otherwise
2275 protected function deleteNewtalk( $field, $id ) {
2276 $dbw = wfGetDB( DB_MASTER
);
2277 $dbw->delete( 'user_newtalk',
2280 if ( $dbw->affectedRows() ) {
2281 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2284 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2290 * Update the 'You have new messages!' status.
2291 * @param bool $val Whether the user has new messages
2292 * @param Revision $curRev New, as yet unseen revision of the user talk
2293 * page. Ignored if null or !$val.
2295 public function setNewtalk( $val, $curRev = null ) {
2296 if ( wfReadOnly() ) {
2301 $this->mNewtalk
= $val;
2303 if ( $this->isAnon() ) {
2305 $id = $this->getName();
2308 $id = $this->getId();
2312 $changed = $this->updateNewtalk( $field, $id, $curRev );
2314 $changed = $this->deleteNewtalk( $field, $id );
2318 $this->invalidateCache();
2323 * Generate a current or new-future timestamp to be stored in the
2324 * user_touched field when we update things.
2325 * @return string Timestamp in TS_MW format
2327 private function newTouchedTimestamp() {
2328 global $wgClockSkewFudge;
2330 $time = wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2331 if ( $this->mTouched
&& $time <= $this->mTouched
) {
2332 $time = wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2339 * Clear user data from memcached
2341 * Use after applying updates to the database; caller's
2342 * responsibility to update user_touched if appropriate.
2344 * Called implicitly from invalidateCache() and saveSettings().
2346 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2348 public function clearSharedCache( $mode = 'changed' ) {
2349 if ( !$this->getId() ) {
2353 $cache = ObjectCache
::getMainWANInstance();
2354 $key = $this->getCacheKey( $cache );
2355 if ( $mode === 'refresh' ) {
2356 $cache->delete( $key, 1 );
2358 wfGetDB( DB_MASTER
)->onTransactionPreCommitOrIdle(
2359 function() use ( $cache, $key ) {
2360 $cache->delete( $key );
2367 * Immediately touch the user data cache for this account
2369 * Calls touch() and removes account data from memcached
2371 public function invalidateCache() {
2373 $this->clearSharedCache();
2377 * Update the "touched" timestamp for the user
2379 * This is useful on various login/logout events when making sure that
2380 * a browser or proxy that has multiple tenants does not suffer cache
2381 * pollution where the new user sees the old users content. The value
2382 * of getTouched() is checked when determining 304 vs 200 responses.
2383 * Unlike invalidateCache(), this preserves the User object cache and
2384 * avoids database writes.
2388 public function touch() {
2389 $id = $this->getId();
2391 $key = wfMemcKey( 'user-quicktouched', 'id', $id );
2392 ObjectCache
::getMainWANInstance()->touchCheckKey( $key );
2393 $this->mQuickTouched
= null;
2398 * Validate the cache for this account.
2399 * @param string $timestamp A timestamp in TS_MW format
2402 public function validateCache( $timestamp ) {
2403 return ( $timestamp >= $this->getTouched() );
2407 * Get the user touched timestamp
2409 * Use this value only to validate caches via inequalities
2410 * such as in the case of HTTP If-Modified-Since response logic
2412 * @return string TS_MW Timestamp
2414 public function getTouched() {
2418 if ( $this->mQuickTouched
=== null ) {
2419 $key = wfMemcKey( 'user-quicktouched', 'id', $this->mId
);
2420 $cache = ObjectCache
::getMainWANInstance();
2422 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2425 return max( $this->mTouched
, $this->mQuickTouched
);
2428 return $this->mTouched
;
2432 * Get the user_touched timestamp field (time of last DB updates)
2433 * @return string TS_MW Timestamp
2436 public function getDBTouched() {
2439 return $this->mTouched
;
2443 * @deprecated Removed in 1.27.
2447 public function getPassword() {
2448 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2452 * @deprecated Removed in 1.27.
2456 public function getTemporaryPassword() {
2457 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2461 * Set the password and reset the random token.
2462 * Calls through to authentication plugin if necessary;
2463 * will have no effect if the auth plugin refuses to
2464 * pass the change through or if the legal password
2467 * As a special case, setting the password to null
2468 * wipes it, so the account cannot be logged in until
2469 * a new password is set, for instance via e-mail.
2471 * @deprecated since 1.27, use AuthManager instead
2472 * @param string $str New password to set
2473 * @throws PasswordError On failure
2476 public function setPassword( $str ) {
2477 return $this->setPasswordInternal( $str );
2481 * Set the password and reset the random token unconditionally.
2483 * @deprecated since 1.27, use AuthManager instead
2484 * @param string|null $str New password to set or null to set an invalid
2485 * password hash meaning that the user will not be able to log in
2486 * through the web interface.
2488 public function setInternalPassword( $str ) {
2489 $this->setPasswordInternal( $str );
2493 * Actually set the password and such
2494 * @since 1.27 cannot set a password for a user not in the database
2495 * @param string|null $str New password to set or null to set an invalid
2496 * password hash meaning that the user will not be able to log in
2497 * through the web interface.
2498 * @return bool Success
2500 private function setPasswordInternal( $str ) {
2501 $manager = AuthManager
::singleton();
2503 // If the user doesn't exist yet, fail
2504 if ( !$manager->userExists( $this->getName() ) ) {
2505 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2508 $status = $this->changeAuthenticationData( [
2509 'username' => $this->getName(),
2513 if ( !$status->isGood() ) {
2514 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2515 ->info( __METHOD__
. ': Password change rejected: '
2516 . $status->getWikiText( null, null, 'en' ) );
2520 $this->setOption( 'watchlisttoken', false );
2521 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2527 * Changes credentials of the user.
2529 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2530 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2531 * e.g. when no provider handled the change.
2533 * @param array $data A set of authentication data in fieldname => value format. This is the
2534 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2538 public function changeAuthenticationData( array $data ) {
2539 $manager = AuthManager
::singleton();
2540 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2541 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2543 $status = Status
::newGood( 'ignored' );
2544 foreach ( $reqs as $req ) {
2545 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2547 if ( $status->getValue() === 'ignored' ) {
2548 $status->warning( 'authenticationdatachange-ignored' );
2551 if ( $status->isGood() ) {
2552 foreach ( $reqs as $req ) {
2553 $manager->changeAuthenticationData( $req );
2560 * Get the user's current token.
2561 * @param bool $forceCreation Force the generation of a new token if the
2562 * user doesn't have one (default=true for backwards compatibility).
2563 * @return string|null Token
2565 public function getToken( $forceCreation = true ) {
2566 global $wgAuthenticationTokenVersion;
2569 if ( !$this->mToken
&& $forceCreation ) {
2573 if ( !$this->mToken
) {
2574 // The user doesn't have a token, return null to indicate that.
2576 } elseif ( $this->mToken
=== self
::INVALID_TOKEN
) {
2577 // We return a random value here so existing token checks are very
2579 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2580 } elseif ( $wgAuthenticationTokenVersion === null ) {
2581 // $wgAuthenticationTokenVersion not in use, so return the raw secret
2582 return $this->mToken
;
2584 // $wgAuthenticationTokenVersion in use, so hmac it.
2585 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
2587 // The raw hash can be overly long. Shorten it up.
2588 $len = max( 32, self
::TOKEN_LENGTH
);
2589 if ( strlen( $ret ) < $len ) {
2590 // Should never happen, even md5 is 128 bits
2591 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
2593 return substr( $ret, -$len );
2598 * Set the random token (used for persistent authentication)
2599 * Called from loadDefaults() among other places.
2601 * @param string|bool $token If specified, set the token to this value
2603 public function setToken( $token = false ) {
2605 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
2606 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
2607 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
2608 } elseif ( !$token ) {
2609 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2611 $this->mToken
= $token;
2616 * Set the password for a password reminder or new account email
2618 * @deprecated Removed in 1.27. Use PasswordReset instead.
2619 * @param string $str New password to set or null to set an invalid
2620 * password hash meaning that the user will not be able to use it
2621 * @param bool $throttle If true, reset the throttle timestamp to the present
2623 public function setNewpassword( $str, $throttle = true ) {
2624 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2628 * Has password reminder email been sent within the last
2629 * $wgPasswordReminderResendTime hours?
2630 * @deprecated Removed in 1.27. See above.
2633 public function isPasswordReminderThrottled() {
2634 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2638 * Get the user's e-mail address
2639 * @return string User's email address
2641 public function getEmail() {
2643 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
2644 return $this->mEmail
;
2648 * Get the timestamp of the user's e-mail authentication
2649 * @return string TS_MW timestamp
2651 public function getEmailAuthenticationTimestamp() {
2653 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
2654 return $this->mEmailAuthenticated
;
2658 * Set the user's e-mail address
2659 * @param string $str New e-mail address
2661 public function setEmail( $str ) {
2663 if ( $str == $this->mEmail
) {
2666 $this->invalidateEmail();
2667 $this->mEmail
= $str;
2668 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
2672 * Set the user's e-mail address and a confirmation mail if needed.
2675 * @param string $str New e-mail address
2678 public function setEmailWithConfirmation( $str ) {
2679 global $wgEnableEmail, $wgEmailAuthentication;
2681 if ( !$wgEnableEmail ) {
2682 return Status
::newFatal( 'emaildisabled' );
2685 $oldaddr = $this->getEmail();
2686 if ( $str === $oldaddr ) {
2687 return Status
::newGood( true );
2690 $type = $oldaddr != '' ?
'changed' : 'set';
2691 $notificationResult = null;
2693 if ( $wgEmailAuthentication ) {
2694 // Send the user an email notifying the user of the change in registered
2695 // email address on their previous email address
2696 if ( $type == 'changed' ) {
2697 $change = $str != '' ?
'changed' : 'removed';
2698 $notificationResult = $this->sendMail(
2699 wfMessage( 'notificationemail_subject_' . $change )->text(),
2700 wfMessage( 'notificationemail_body_' . $change,
2701 $this->getRequest()->getIP(),
2708 $this->setEmail( $str );
2710 if ( $str !== '' && $wgEmailAuthentication ) {
2711 // Send a confirmation request to the new address if needed
2712 $result = $this->sendConfirmationMail( $type );
2714 if ( $notificationResult !== null ) {
2715 $result->merge( $notificationResult );
2718 if ( $result->isGood() ) {
2719 // Say to the caller that a confirmation and notification mail has been sent
2720 $result->value
= 'eauth';
2723 $result = Status
::newGood( true );
2730 * Get the user's real name
2731 * @return string User's real name
2733 public function getRealName() {
2734 if ( !$this->isItemLoaded( 'realname' ) ) {
2738 return $this->mRealName
;
2742 * Set the user's real name
2743 * @param string $str New real name
2745 public function setRealName( $str ) {
2747 $this->mRealName
= $str;
2751 * Get the user's current setting for a given option.
2753 * @param string $oname The option to check
2754 * @param string $defaultOverride A default value returned if the option does not exist
2755 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2756 * @return string User's current value for the option
2757 * @see getBoolOption()
2758 * @see getIntOption()
2760 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2761 global $wgHiddenPrefs;
2762 $this->loadOptions();
2764 # We want 'disabled' preferences to always behave as the default value for
2765 # users, even if they have set the option explicitly in their settings (ie they
2766 # set it, and then it was disabled removing their ability to change it). But
2767 # we don't want to erase the preferences in the database in case the preference
2768 # is re-enabled again. So don't touch $mOptions, just override the returned value
2769 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2770 return self
::getDefaultOption( $oname );
2773 if ( array_key_exists( $oname, $this->mOptions
) ) {
2774 return $this->mOptions
[$oname];
2776 return $defaultOverride;
2781 * Get all user's options
2783 * @param int $flags Bitwise combination of:
2784 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
2785 * to the default value. (Since 1.25)
2788 public function getOptions( $flags = 0 ) {
2789 global $wgHiddenPrefs;
2790 $this->loadOptions();
2791 $options = $this->mOptions
;
2793 # We want 'disabled' preferences to always behave as the default value for
2794 # users, even if they have set the option explicitly in their settings (ie they
2795 # set it, and then it was disabled removing their ability to change it). But
2796 # we don't want to erase the preferences in the database in case the preference
2797 # is re-enabled again. So don't touch $mOptions, just override the returned value
2798 foreach ( $wgHiddenPrefs as $pref ) {
2799 $default = self
::getDefaultOption( $pref );
2800 if ( $default !== null ) {
2801 $options[$pref] = $default;
2805 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
2806 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
2813 * Get the user's current setting for a given option, as a boolean value.
2815 * @param string $oname The option to check
2816 * @return bool User's current value for the option
2819 public function getBoolOption( $oname ) {
2820 return (bool)$this->getOption( $oname );
2824 * Get the user's current setting for a given option, as an integer value.
2826 * @param string $oname The option to check
2827 * @param int $defaultOverride A default value returned if the option does not exist
2828 * @return int User's current value for the option
2831 public function getIntOption( $oname, $defaultOverride = 0 ) {
2832 $val = $this->getOption( $oname );
2834 $val = $defaultOverride;
2836 return intval( $val );
2840 * Set the given option for a user.
2842 * You need to call saveSettings() to actually write to the database.
2844 * @param string $oname The option to set
2845 * @param mixed $val New value to set
2847 public function setOption( $oname, $val ) {
2848 $this->loadOptions();
2850 // Explicitly NULL values should refer to defaults
2851 if ( is_null( $val ) ) {
2852 $val = self
::getDefaultOption( $oname );
2855 $this->mOptions
[$oname] = $val;
2859 * Get a token stored in the preferences (like the watchlist one),
2860 * resetting it if it's empty (and saving changes).
2862 * @param string $oname The option name to retrieve the token from
2863 * @return string|bool User's current value for the option, or false if this option is disabled.
2864 * @see resetTokenFromOption()
2866 * @deprecated since 1.26 Applications should use the OAuth extension
2868 public function getTokenFromOption( $oname ) {
2869 global $wgHiddenPrefs;
2871 $id = $this->getId();
2872 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
2876 $token = $this->getOption( $oname );
2878 // Default to a value based on the user token to avoid space
2879 // wasted on storing tokens for all users. When this option
2880 // is set manually by the user, only then is it stored.
2881 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
2888 * Reset a token stored in the preferences (like the watchlist one).
2889 * *Does not* save user's preferences (similarly to setOption()).
2891 * @param string $oname The option name to reset the token in
2892 * @return string|bool New token value, or false if this option is disabled.
2893 * @see getTokenFromOption()
2896 public function resetTokenFromOption( $oname ) {
2897 global $wgHiddenPrefs;
2898 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2902 $token = MWCryptRand
::generateHex( 40 );
2903 $this->setOption( $oname, $token );
2908 * Return a list of the types of user options currently returned by
2909 * User::getOptionKinds().
2911 * Currently, the option kinds are:
2912 * - 'registered' - preferences which are registered in core MediaWiki or
2913 * by extensions using the UserGetDefaultOptions hook.
2914 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2915 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
2916 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2917 * be used by user scripts.
2918 * - 'special' - "preferences" that are not accessible via User::getOptions
2919 * or User::setOptions.
2920 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2921 * These are usually legacy options, removed in newer versions.
2923 * The API (and possibly others) use this function to determine the possible
2924 * option types for validation purposes, so make sure to update this when a
2925 * new option kind is added.
2927 * @see User::getOptionKinds
2928 * @return array Option kinds
2930 public static function listOptionKinds() {
2933 'registered-multiselect',
2934 'registered-checkmatrix',
2942 * Return an associative array mapping preferences keys to the kind of a preference they're
2943 * used for. Different kinds are handled differently when setting or reading preferences.
2945 * See User::listOptionKinds for the list of valid option types that can be provided.
2947 * @see User::listOptionKinds
2948 * @param IContextSource $context
2949 * @param array $options Assoc. array with options keys to check as keys.
2950 * Defaults to $this->mOptions.
2951 * @return array The key => kind mapping data
2953 public function getOptionKinds( IContextSource
$context, $options = null ) {
2954 $this->loadOptions();
2955 if ( $options === null ) {
2956 $options = $this->mOptions
;
2959 $prefs = Preferences
::getPreferences( $this, $context );
2962 // Pull out the "special" options, so they don't get converted as
2963 // multiselect or checkmatrix.
2964 $specialOptions = array_fill_keys( Preferences
::getSaveBlacklist(), true );
2965 foreach ( $specialOptions as $name => $value ) {
2966 unset( $prefs[$name] );
2969 // Multiselect and checkmatrix options are stored in the database with
2970 // one key per option, each having a boolean value. Extract those keys.
2971 $multiselectOptions = [];
2972 foreach ( $prefs as $name => $info ) {
2973 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
2974 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
2975 $opts = HTMLFormField
::flattenOptions( $info['options'] );
2976 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2978 foreach ( $opts as $value ) {
2979 $multiselectOptions["$prefix$value"] = true;
2982 unset( $prefs[$name] );
2985 $checkmatrixOptions = [];
2986 foreach ( $prefs as $name => $info ) {
2987 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
2988 ( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
2989 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
2990 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
2991 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2993 foreach ( $columns as $column ) {
2994 foreach ( $rows as $row ) {
2995 $checkmatrixOptions["$prefix$column-$row"] = true;
2999 unset( $prefs[$name] );
3003 // $value is ignored
3004 foreach ( $options as $key => $value ) {
3005 if ( isset( $prefs[$key] ) ) {
3006 $mapping[$key] = 'registered';
3007 } elseif ( isset( $multiselectOptions[$key] ) ) {
3008 $mapping[$key] = 'registered-multiselect';
3009 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3010 $mapping[$key] = 'registered-checkmatrix';
3011 } elseif ( isset( $specialOptions[$key] ) ) {
3012 $mapping[$key] = 'special';
3013 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3014 $mapping[$key] = 'userjs';
3016 $mapping[$key] = 'unused';
3024 * Reset certain (or all) options to the site defaults
3026 * The optional parameter determines which kinds of preferences will be reset.
3027 * Supported values are everything that can be reported by getOptionKinds()
3028 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3030 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3031 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3032 * for backwards-compatibility.
3033 * @param IContextSource|null $context Context source used when $resetKinds
3034 * does not contain 'all', passed to getOptionKinds().
3035 * Defaults to RequestContext::getMain() when null.
3037 public function resetOptions(
3038 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3039 IContextSource
$context = null
3042 $defaultOptions = self
::getDefaultOptions();
3044 if ( !is_array( $resetKinds ) ) {
3045 $resetKinds = [ $resetKinds ];
3048 if ( in_array( 'all', $resetKinds ) ) {
3049 $newOptions = $defaultOptions;
3051 if ( $context === null ) {
3052 $context = RequestContext
::getMain();
3055 $optionKinds = $this->getOptionKinds( $context );
3056 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3059 // Use default values for the options that should be deleted, and
3060 // copy old values for the ones that shouldn't.
3061 foreach ( $this->mOptions
as $key => $value ) {
3062 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3063 if ( array_key_exists( $key, $defaultOptions ) ) {
3064 $newOptions[$key] = $defaultOptions[$key];
3067 $newOptions[$key] = $value;
3072 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3074 $this->mOptions
= $newOptions;
3075 $this->mOptionsLoaded
= true;
3079 * Get the user's preferred date format.
3080 * @return string User's preferred date format
3082 public function getDatePreference() {
3083 // Important migration for old data rows
3084 if ( is_null( $this->mDatePreference
) ) {
3086 $value = $this->getOption( 'date' );
3087 $map = $wgLang->getDatePreferenceMigrationMap();
3088 if ( isset( $map[$value] ) ) {
3089 $value = $map[$value];
3091 $this->mDatePreference
= $value;
3093 return $this->mDatePreference
;
3097 * Determine based on the wiki configuration and the user's options,
3098 * whether this user must be over HTTPS no matter what.
3102 public function requiresHTTPS() {
3103 global $wgSecureLogin;
3104 if ( !$wgSecureLogin ) {
3107 $https = $this->getBoolOption( 'prefershttps' );
3108 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3110 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3117 * Get the user preferred stub threshold
3121 public function getStubThreshold() {
3122 global $wgMaxArticleSize; # Maximum article size, in Kb
3123 $threshold = $this->getIntOption( 'stubthreshold' );
3124 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3125 // If they have set an impossible value, disable the preference
3126 // so we can use the parser cache again.
3133 * Get the permissions this user has.
3134 * @return array Array of String permission names
3136 public function getRights() {
3137 if ( is_null( $this->mRights
) ) {
3138 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3139 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3141 // Deny any rights denied by the user's session, unless this
3142 // endpoint has no sessions.
3143 if ( !defined( 'MW_NO_SESSION' ) ) {
3144 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3145 if ( $allowedRights !== null ) {
3146 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3150 // Force reindexation of rights when a hook has unset one of them
3151 $this->mRights
= array_values( array_unique( $this->mRights
) );
3153 // If block disables login, we should also remove any
3154 // extra rights blocked users might have, in case the
3155 // blocked user has a pre-existing session (T129738).
3156 // This is checked here for cases where people only call
3157 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3158 // to give a better error message in the common case.
3159 $config = RequestContext
::getMain()->getConfig();
3161 $this->isLoggedIn() &&
3162 $config->get( 'BlockDisablesLogin' ) &&
3166 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3169 return $this->mRights
;
3173 * Get the list of explicit group memberships this user has.
3174 * The implicit * and user groups are not included.
3175 * @return array Array of String internal group names
3177 public function getGroups() {
3179 $this->loadGroups();
3180 return $this->mGroups
;
3184 * Get the list of implicit group memberships this user has.
3185 * This includes all explicit groups, plus 'user' if logged in,
3186 * '*' for all accounts, and autopromoted groups
3187 * @param bool $recache Whether to avoid the cache
3188 * @return array Array of String internal group names
3190 public function getEffectiveGroups( $recache = false ) {
3191 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3192 $this->mEffectiveGroups
= array_unique( array_merge(
3193 $this->getGroups(), // explicit groups
3194 $this->getAutomaticGroups( $recache ) // implicit groups
3196 // Hook for additional groups
3197 Hooks
::run( 'UserEffectiveGroups', [ &$this, &$this->mEffectiveGroups
] );
3198 // Force reindexation of groups when a hook has unset one of them
3199 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3201 return $this->mEffectiveGroups
;
3205 * Get the list of implicit group memberships this user has.
3206 * This includes 'user' if logged in, '*' for all accounts,
3207 * and autopromoted groups
3208 * @param bool $recache Whether to avoid the cache
3209 * @return array Array of String internal group names
3211 public function getAutomaticGroups( $recache = false ) {
3212 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3213 $this->mImplicitGroups
= [ '*' ];
3214 if ( $this->getId() ) {
3215 $this->mImplicitGroups
[] = 'user';
3217 $this->mImplicitGroups
= array_unique( array_merge(
3218 $this->mImplicitGroups
,
3219 Autopromote
::getAutopromoteGroups( $this )
3223 // Assure data consistency with rights/groups,
3224 // as getEffectiveGroups() depends on this function
3225 $this->mEffectiveGroups
= null;
3228 return $this->mImplicitGroups
;
3232 * Returns the groups the user has belonged to.
3234 * The user may still belong to the returned groups. Compare with getGroups().
3236 * The function will not return groups the user had belonged to before MW 1.17
3238 * @return array Names of the groups the user has belonged to.
3240 public function getFormerGroups() {
3243 if ( is_null( $this->mFormerGroups
) ) {
3244 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3245 ?
wfGetDB( DB_MASTER
)
3246 : wfGetDB( DB_REPLICA
);
3247 $res = $db->select( 'user_former_groups',
3249 [ 'ufg_user' => $this->mId
],
3251 $this->mFormerGroups
= [];
3252 foreach ( $res as $row ) {
3253 $this->mFormerGroups
[] = $row->ufg_group
;
3257 return $this->mFormerGroups
;
3261 * Get the user's edit count.
3262 * @return int|null Null for anonymous users
3264 public function getEditCount() {
3265 if ( !$this->getId() ) {
3269 if ( $this->mEditCount
=== null ) {
3270 /* Populate the count, if it has not been populated yet */
3271 $dbr = wfGetDB( DB_REPLICA
);
3272 // check if the user_editcount field has been initialized
3273 $count = $dbr->selectField(
3274 'user', 'user_editcount',
3275 [ 'user_id' => $this->mId
],
3279 if ( $count === null ) {
3280 // it has not been initialized. do so.
3281 $count = $this->initEditCount();
3283 $this->mEditCount
= $count;
3285 return (int)$this->mEditCount
;
3289 * Add the user to the given group.
3290 * This takes immediate effect.
3291 * @param string $group Name of the group to add
3294 public function addGroup( $group ) {
3297 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group ] ) ) {
3301 $dbw = wfGetDB( DB_MASTER
);
3302 if ( $this->getId() ) {
3303 $dbw->insert( 'user_groups',
3305 'ug_user' => $this->getId(),
3306 'ug_group' => $group,
3312 $this->loadGroups();
3313 $this->mGroups
[] = $group;
3314 // In case loadGroups was not called before, we now have the right twice.
3315 // Get rid of the duplicate.
3316 $this->mGroups
= array_unique( $this->mGroups
);
3318 // Refresh the groups caches, and clear the rights cache so it will be
3319 // refreshed on the next call to $this->getRights().
3320 $this->getEffectiveGroups( true );
3321 $this->mRights
= null;
3323 $this->invalidateCache();
3329 * Remove the user from the given group.
3330 * This takes immediate effect.
3331 * @param string $group Name of the group to remove
3334 public function removeGroup( $group ) {
3336 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3340 $dbw = wfGetDB( DB_MASTER
);
3341 $dbw->delete( 'user_groups',
3343 'ug_user' => $this->getId(),
3344 'ug_group' => $group,
3347 // Remember that the user was in this group
3348 $dbw->insert( 'user_former_groups',
3350 'ufg_user' => $this->getId(),
3351 'ufg_group' => $group,
3357 $this->loadGroups();
3358 $this->mGroups
= array_diff( $this->mGroups
, [ $group ] );
3360 // Refresh the groups caches, and clear the rights cache so it will be
3361 // refreshed on the next call to $this->getRights().
3362 $this->getEffectiveGroups( true );
3363 $this->mRights
= null;
3365 $this->invalidateCache();
3371 * Get whether the user is logged in
3374 public function isLoggedIn() {
3375 return $this->getId() != 0;
3379 * Get whether the user is anonymous
3382 public function isAnon() {
3383 return !$this->isLoggedIn();
3387 * @return bool Whether this user is flagged as being a bot role account
3390 public function isBot() {
3391 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3396 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3402 * Check if user is allowed to access a feature / make an action
3404 * @param string ... Permissions to test
3405 * @return bool True if user is allowed to perform *any* of the given actions
3407 public function isAllowedAny() {
3408 $permissions = func_get_args();
3409 foreach ( $permissions as $permission ) {
3410 if ( $this->isAllowed( $permission ) ) {
3419 * @param string ... Permissions to test
3420 * @return bool True if the user is allowed to perform *all* of the given actions
3422 public function isAllowedAll() {
3423 $permissions = func_get_args();
3424 foreach ( $permissions as $permission ) {
3425 if ( !$this->isAllowed( $permission ) ) {
3433 * Internal mechanics of testing a permission
3434 * @param string $action
3437 public function isAllowed( $action = '' ) {
3438 if ( $action === '' ) {
3439 return true; // In the spirit of DWIM
3441 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3442 // by misconfiguration: 0 == 'foo'
3443 return in_array( $action, $this->getRights(), true );
3447 * Check whether to enable recent changes patrol features for this user
3448 * @return bool True or false
3450 public function useRCPatrol() {
3451 global $wgUseRCPatrol;
3452 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3456 * Check whether to enable new pages patrol features for this user
3457 * @return bool True or false
3459 public function useNPPatrol() {
3460 global $wgUseRCPatrol, $wgUseNPPatrol;
3462 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3463 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3468 * Check whether to enable new files patrol features for this user
3469 * @return bool True or false
3471 public function useFilePatrol() {
3472 global $wgUseRCPatrol, $wgUseFilePatrol;
3474 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3475 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3480 * Get the WebRequest object to use with this object
3482 * @return WebRequest
3484 public function getRequest() {
3485 if ( $this->mRequest
) {
3486 return $this->mRequest
;
3494 * Check the watched status of an article.
3495 * @since 1.22 $checkRights parameter added
3496 * @param Title $title Title of the article to look at
3497 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3498 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3501 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3502 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3503 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3510 * @since 1.22 $checkRights parameter added
3511 * @param Title $title Title of the article to look at
3512 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3513 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3515 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3516 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3517 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3519 [ $title->getSubjectPage(), $title->getTalkPage() ]
3522 $this->invalidateCache();
3526 * Stop watching an article.
3527 * @since 1.22 $checkRights parameter added
3528 * @param Title $title Title of the article to look at
3529 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3530 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3532 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3533 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3534 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3535 $store->removeWatch( $this, $title->getSubjectPage() );
3536 $store->removeWatch( $this, $title->getTalkPage() );
3538 $this->invalidateCache();
3542 * Clear the user's notification timestamp for the given title.
3543 * If e-notif e-mails are on, they will receive notification mails on
3544 * the next change of the page if it's watched etc.
3545 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3546 * @param Title $title Title of the article to look at
3547 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3549 public function clearNotification( &$title, $oldid = 0 ) {
3550 global $wgUseEnotif, $wgShowUpdatedMarker;
3552 // Do nothing if the database is locked to writes
3553 if ( wfReadOnly() ) {
3557 // Do nothing if not allowed to edit the watchlist
3558 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3562 // If we're working on user's talk page, we should update the talk page message indicator
3563 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3564 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$this, $oldid ] ) ) {
3568 // Try to update the DB post-send and only if needed...
3569 DeferredUpdates
::addCallableUpdate( function() use ( $title, $oldid ) {
3570 if ( !$this->getNewtalk() ) {
3571 return; // no notifications to clear
3574 // Delete the last notifications (they stack up)
3575 $this->setNewtalk( false );
3577 // If there is a new, unseen, revision, use its timestamp
3579 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
3582 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
3587 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3591 if ( $this->isAnon() ) {
3592 // Nothing else to do...
3596 // Only update the timestamp if the page is being watched.
3597 // The query to find out if it is watched is cached both in memcached and per-invocation,
3598 // and when it does have to be executed, it can be on a replica DB
3599 // If this is the user's newtalk page, we always update the timestamp
3601 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3605 MediaWikiServices
::getInstance()->getWatchedItemStore()
3606 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
3610 * Resets all of the given user's page-change notification timestamps.
3611 * If e-notif e-mails are on, they will receive notification mails on
3612 * the next change of any watched page.
3613 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3615 public function clearAllNotifications() {
3616 global $wgUseEnotif, $wgShowUpdatedMarker;
3617 // Do nothing if not allowed to edit the watchlist
3618 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
3622 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3623 $this->setNewtalk( false );
3627 $id = $this->getId();
3632 $dbw = wfGetDB( DB_MASTER
);
3633 $asOfTimes = array_unique( $dbw->selectFieldValues(
3635 'wl_notificationtimestamp',
3636 [ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ],
3638 [ 'ORDER BY' => 'wl_notificationtimestamp DESC', 'LIMIT' => 500 ]
3640 if ( !$asOfTimes ) {
3643 // Immediately update the most recent touched rows, which hopefully covers what
3644 // the user sees on the watchlist page before pressing "mark all pages visited"....
3647 [ 'wl_notificationtimestamp' => null ],
3648 [ 'wl_user' => $id, 'wl_notificationtimestamp' => $asOfTimes ],
3651 // ...and finish the older ones in a post-send update with lag checks...
3652 DeferredUpdates
::addUpdate( new AutoCommitUpdate(
3655 function () use ( $dbw, $id ) {
3656 global $wgUpdateRowsPerQuery;
3658 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
3659 $ticket = $lbFactory->getEmptyTransactionTicket( __METHOD__
);
3660 $asOfTimes = array_unique( $dbw->selectFieldValues(
3662 'wl_notificationtimestamp',
3663 [ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ],
3666 foreach ( array_chunk( $asOfTimes, $wgUpdateRowsPerQuery ) as $asOfTimeBatch ) {
3669 [ 'wl_notificationtimestamp' => null ],
3670 [ 'wl_user' => $id, 'wl_notificationtimestamp' => $asOfTimeBatch ],
3673 $lbFactory->commitAndWaitForReplication( __METHOD__
, $ticket );
3677 // We also need to clear here the "you have new message" notification for the own
3678 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
3682 * Set a cookie on the user's client. Wrapper for
3683 * WebResponse::setCookie
3684 * @deprecated since 1.27
3685 * @param string $name Name of the cookie to set
3686 * @param string $value Value to set
3687 * @param int $exp Expiration time, as a UNIX time value;
3688 * if 0 or not specified, use the default $wgCookieExpiration
3689 * @param bool $secure
3690 * true: Force setting the secure attribute when setting the cookie
3691 * false: Force NOT setting the secure attribute when setting the cookie
3692 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3693 * @param array $params Array of options sent passed to WebResponse::setcookie()
3694 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3697 protected function setCookie(
3698 $name, $value, $exp = 0, $secure = null, $params = [], $request = null
3700 wfDeprecated( __METHOD__
, '1.27' );
3701 if ( $request === null ) {
3702 $request = $this->getRequest();
3704 $params['secure'] = $secure;
3705 $request->response()->setCookie( $name, $value, $exp, $params );
3709 * Clear a cookie on the user's client
3710 * @deprecated since 1.27
3711 * @param string $name Name of the cookie to clear
3712 * @param bool $secure
3713 * true: Force setting the secure attribute when setting the cookie
3714 * false: Force NOT setting the secure attribute when setting the cookie
3715 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3716 * @param array $params Array of options sent passed to WebResponse::setcookie()
3718 protected function clearCookie( $name, $secure = null, $params = [] ) {
3719 wfDeprecated( __METHOD__
, '1.27' );
3720 $this->setCookie( $name, '', time() - 86400, $secure, $params );
3724 * Set an extended login cookie on the user's client. The expiry of the cookie
3725 * is controlled by the $wgExtendedLoginCookieExpiration configuration
3728 * @see User::setCookie
3730 * @deprecated since 1.27
3731 * @param string $name Name of the cookie to set
3732 * @param string $value Value to set
3733 * @param bool $secure
3734 * true: Force setting the secure attribute when setting the cookie
3735 * false: Force NOT setting the secure attribute when setting the cookie
3736 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3738 protected function setExtendedLoginCookie( $name, $value, $secure ) {
3739 global $wgExtendedLoginCookieExpiration, $wgCookieExpiration;
3741 wfDeprecated( __METHOD__
, '1.27' );
3744 $exp +
= $wgExtendedLoginCookieExpiration !== null
3745 ?
$wgExtendedLoginCookieExpiration
3746 : $wgCookieExpiration;
3748 $this->setCookie( $name, $value, $exp, $secure );
3752 * Persist this user's session (e.g. set cookies)
3754 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3756 * @param bool $secure Whether to force secure/insecure cookies or use default
3757 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3759 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3761 if ( 0 == $this->mId
) {
3765 $session = $this->getRequest()->getSession();
3766 if ( $request && $session->getRequest() !== $request ) {
3767 $session = $session->sessionWithRequest( $request );
3769 $delay = $session->delaySave();
3771 if ( !$session->getUser()->equals( $this ) ) {
3772 if ( !$session->canSetUser() ) {
3773 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3774 ->warning( __METHOD__
.
3775 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
3779 $session->setUser( $this );
3782 $session->setRememberUser( $rememberMe );
3783 if ( $secure !== null ) {
3784 $session->setForceHTTPS( $secure );
3787 $session->persist();
3789 ScopedCallback
::consume( $delay );
3793 * Log this user out.
3795 public function logout() {
3796 if ( Hooks
::run( 'UserLogout', [ &$this ] ) ) {
3802 * Clear the user's session, and reset the instance cache.
3805 public function doLogout() {
3806 $session = $this->getRequest()->getSession();
3807 if ( !$session->canSetUser() ) {
3808 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3809 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
3810 $error = 'immutable';
3811 } elseif ( !$session->getUser()->equals( $this ) ) {
3812 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3813 ->warning( __METHOD__
.
3814 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
3816 // But we still may as well make this user object anon
3817 $this->clearInstanceCache( 'defaults' );
3818 $error = 'wronguser';
3820 $this->clearInstanceCache( 'defaults' );
3821 $delay = $session->delaySave();
3822 $session->unpersist(); // Clear cookies (T127436)
3823 $session->setLoggedOutTimestamp( time() );
3824 $session->setUser( new User
);
3825 $session->set( 'wsUserID', 0 ); // Other code expects this
3826 $session->resetAllTokens();
3827 ScopedCallback
::consume( $delay );
3830 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
3831 'event' => 'logout',
3832 'successful' => $error === false,
3833 'status' => $error ?
: 'success',
3838 * Save this user's settings into the database.
3839 * @todo Only rarely do all these fields need to be set!
3841 public function saveSettings() {
3842 if ( wfReadOnly() ) {
3843 // @TODO: caller should deal with this instead!
3844 // This should really just be an exception.
3845 MWExceptionHandler
::logException( new DBExpectedError(
3847 "Could not update user with ID '{$this->mId}'; DB is read-only."
3853 if ( 0 == $this->mId
) {
3857 // Get a new user_touched that is higher than the old one.
3858 // This will be used for a CAS check as a last-resort safety
3859 // check against race conditions and replica DB lag.
3860 $newTouched = $this->newTouchedTimestamp();
3862 $dbw = wfGetDB( DB_MASTER
);
3863 $dbw->update( 'user',
3865 'user_name' => $this->mName
,
3866 'user_real_name' => $this->mRealName
,
3867 'user_email' => $this->mEmail
,
3868 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3869 'user_touched' => $dbw->timestamp( $newTouched ),
3870 'user_token' => strval( $this->mToken
),
3871 'user_email_token' => $this->mEmailToken
,
3872 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
3873 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
3874 'user_id' => $this->mId
,
3878 if ( !$dbw->affectedRows() ) {
3879 // Maybe the problem was a missed cache update; clear it to be safe
3880 $this->clearSharedCache( 'refresh' );
3881 // User was changed in the meantime or loaded with stale data
3882 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
3883 throw new MWException(
3884 "CAS update failed on user_touched for user ID '{$this->mId}' (read from $from);" .
3885 " the version of the user to be saved is older than the current version."
3889 $this->mTouched
= $newTouched;
3890 $this->saveOptions();
3892 Hooks
::run( 'UserSaveSettings', [ $this ] );
3893 $this->clearSharedCache();
3894 $this->getUserPage()->invalidateCache();
3898 * If only this user's username is known, and it exists, return the user ID.
3900 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
3903 public function idForName( $flags = 0 ) {
3904 $s = trim( $this->getName() );
3909 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
3910 ?
wfGetDB( DB_MASTER
)
3911 : wfGetDB( DB_REPLICA
);
3913 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
3914 ?
[ 'LOCK IN SHARE MODE' ]
3917 $id = $db->selectField( 'user',
3918 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
3924 * Add a user to the database, return the user object
3926 * @param string $name Username to add
3927 * @param array $params Array of Strings Non-default parameters to save to
3928 * the database as user_* fields:
3929 * - email: The user's email address.
3930 * - email_authenticated: The email authentication timestamp.
3931 * - real_name: The user's real name.
3932 * - options: An associative array of non-default options.
3933 * - token: Random authentication token. Do not set.
3934 * - registration: Registration timestamp. Do not set.
3936 * @return User|null User object, or null if the username already exists.
3938 public static function createNew( $name, $params = [] ) {
3939 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
3940 if ( isset( $params[$field] ) ) {
3941 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
3942 unset( $params[$field] );
3948 $user->setToken(); // init token
3949 if ( isset( $params['options'] ) ) {
3950 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
3951 unset( $params['options'] );
3953 $dbw = wfGetDB( DB_MASTER
);
3954 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3956 $noPass = PasswordFactory
::newInvalidPassword()->toString();
3959 'user_id' => $seqVal,
3960 'user_name' => $name,
3961 'user_password' => $noPass,
3962 'user_newpassword' => $noPass,
3963 'user_email' => $user->mEmail
,
3964 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
3965 'user_real_name' => $user->mRealName
,
3966 'user_token' => strval( $user->mToken
),
3967 'user_registration' => $dbw->timestamp( $user->mRegistration
),
3968 'user_editcount' => 0,
3969 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
3971 foreach ( $params as $name => $value ) {
3972 $fields["user_$name"] = $value;
3974 $dbw->insert( 'user', $fields, __METHOD__
, [ 'IGNORE' ] );
3975 if ( $dbw->affectedRows() ) {
3976 $newUser = User
::newFromId( $dbw->insertId() );
3984 * Add this existing user object to the database. If the user already
3985 * exists, a fatal status object is returned, and the user object is
3986 * initialised with the data from the database.
3988 * Previously, this function generated a DB error due to a key conflict
3989 * if the user already existed. Many extension callers use this function
3990 * in code along the lines of:
3992 * $user = User::newFromName( $name );
3993 * if ( !$user->isLoggedIn() ) {
3994 * $user->addToDatabase();
3996 * // do something with $user...
3998 * However, this was vulnerable to a race condition (bug 16020). By
3999 * initialising the user object if the user exists, we aim to support this
4000 * calling sequence as far as possible.
4002 * Note that if the user exists, this function will acquire a write lock,
4003 * so it is still advisable to make the call conditional on isLoggedIn(),
4004 * and to commit the transaction after calling.
4006 * @throws MWException
4009 public function addToDatabase() {
4011 if ( !$this->mToken
) {
4012 $this->setToken(); // init token
4015 $this->mTouched
= $this->newTouchedTimestamp();
4017 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4019 $dbw = wfGetDB( DB_MASTER
);
4020 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
4021 $dbw->insert( 'user',
4023 'user_id' => $seqVal,
4024 'user_name' => $this->mName
,
4025 'user_password' => $noPass,
4026 'user_newpassword' => $noPass,
4027 'user_email' => $this->mEmail
,
4028 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4029 'user_real_name' => $this->mRealName
,
4030 'user_token' => strval( $this->mToken
),
4031 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4032 'user_editcount' => 0,
4033 'user_touched' => $dbw->timestamp( $this->mTouched
),
4037 if ( !$dbw->affectedRows() ) {
4038 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4039 $this->mId
= $dbw->selectField(
4042 [ 'user_name' => $this->mName
],
4044 [ 'LOCK IN SHARE MODE' ]
4048 if ( $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4053 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
4054 "to insert user '{$this->mName}' row, but it was not present in select!" );
4056 return Status
::newFatal( 'userexists' );
4058 $this->mId
= $dbw->insertId();
4059 self
::$idCacheByName[$this->mName
] = $this->mId
;
4061 // Clear instance cache other than user table data, which is already accurate
4062 $this->clearInstanceCache();
4064 $this->saveOptions();
4065 return Status
::newGood();
4069 * If this user is logged-in and blocked,
4070 * block any IP address they've successfully logged in from.
4071 * @return bool A block was spread
4073 public function spreadAnyEditBlock() {
4074 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4075 return $this->spreadBlock();
4082 * If this (non-anonymous) user is blocked,
4083 * block the IP address they've successfully logged in from.
4084 * @return bool A block was spread
4086 protected function spreadBlock() {
4087 wfDebug( __METHOD__
. "()\n" );
4089 if ( $this->mId
== 0 ) {
4093 $userblock = Block
::newFromTarget( $this->getName() );
4094 if ( !$userblock ) {
4098 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4102 * Get whether the user is explicitly blocked from account creation.
4103 * @return bool|Block
4105 public function isBlockedFromCreateAccount() {
4106 $this->getBlockedStatus();
4107 if ( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
4108 return $this->mBlock
;
4111 # bug 13611: if the IP address the user is trying to create an account from is
4112 # blocked with createaccount disabled, prevent new account creation there even
4113 # when the user is logged in
4114 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4115 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4117 return $this->mBlockedFromCreateAccount
instanceof Block
4118 && $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
4119 ?
$this->mBlockedFromCreateAccount
4124 * Get whether the user is blocked from using Special:Emailuser.
4127 public function isBlockedFromEmailuser() {
4128 $this->getBlockedStatus();
4129 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
4133 * Get whether the user is allowed to create an account.
4136 public function isAllowedToCreateAccount() {
4137 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4141 * Get this user's personal page title.
4143 * @return Title User's personal page title
4145 public function getUserPage() {
4146 return Title
::makeTitle( NS_USER
, $this->getName() );
4150 * Get this user's talk page title.
4152 * @return Title User's talk page title
4154 public function getTalkPage() {
4155 $title = $this->getUserPage();
4156 return $title->getTalkPage();
4160 * Determine whether the user is a newbie. Newbies are either
4161 * anonymous IPs, or the most recently created accounts.
4164 public function isNewbie() {
4165 return !$this->isAllowed( 'autoconfirmed' );
4169 * Check to see if the given clear-text password is one of the accepted passwords
4170 * @deprecated since 1.27, use AuthManager instead
4171 * @param string $password User password
4172 * @return bool True if the given password is correct, otherwise False
4174 public function checkPassword( $password ) {
4175 $manager = AuthManager
::singleton();
4176 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4177 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4179 'username' => $this->getName(),
4180 'password' => $password,
4183 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4184 switch ( $res->status
) {
4185 case AuthenticationResponse
::PASS
:
4187 case AuthenticationResponse
::FAIL
:
4188 // Hope it's not a PreAuthenticationProvider that failed...
4189 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4190 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4193 throw new BadMethodCallException(
4194 'AuthManager returned a response unsupported by ' . __METHOD__
4200 * Check if the given clear-text password matches the temporary password
4201 * sent by e-mail for password reset operations.
4203 * @deprecated since 1.27, use AuthManager instead
4204 * @param string $plaintext
4205 * @return bool True if matches, false otherwise
4207 public function checkTemporaryPassword( $plaintext ) {
4208 // Can't check the temporary password individually.
4209 return $this->checkPassword( $plaintext );
4213 * Initialize (if necessary) and return a session token value
4214 * which can be used in edit forms to show that the user's
4215 * login credentials aren't being hijacked with a foreign form
4219 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4220 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4221 * @return MediaWiki\Session\Token The new edit token
4223 public function getEditTokenObject( $salt = '', $request = null ) {
4224 if ( $this->isAnon() ) {
4225 return new LoggedOutEditToken();
4229 $request = $this->getRequest();
4231 return $request->getSession()->getToken( $salt );
4235 * Initialize (if necessary) and return a session token value
4236 * which can be used in edit forms to show that the user's
4237 * login credentials aren't being hijacked with a foreign form
4240 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4243 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4244 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4245 * @return string The new edit token
4247 public function getEditToken( $salt = '', $request = null ) {
4248 return $this->getEditTokenObject( $salt, $request )->toString();
4252 * Get the embedded timestamp from a token.
4253 * @deprecated since 1.27, use \MediaWiki\Session\Token::getTimestamp instead.
4254 * @param string $val Input token
4257 public static function getEditTokenTimestamp( $val ) {
4258 wfDeprecated( __METHOD__
, '1.27' );
4259 return MediaWiki\Session\Token
::getTimestamp( $val );
4263 * Check given value against the token value stored in the session.
4264 * A match should confirm that the form was submitted from the
4265 * user's own login session, not a form submission from a third-party
4268 * @param string $val Input value to compare
4269 * @param string $salt Optional function-specific data for hashing
4270 * @param WebRequest|null $request Object to use or null to use $wgRequest
4271 * @param int $maxage Fail tokens older than this, in seconds
4272 * @return bool Whether the token matches
4274 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4275 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4279 * Check given value against the token value stored in the session,
4280 * ignoring the suffix.
4282 * @param string $val Input value to compare
4283 * @param string $salt Optional function-specific data for hashing
4284 * @param WebRequest|null $request Object to use or null to use $wgRequest
4285 * @param int $maxage Fail tokens older than this, in seconds
4286 * @return bool Whether the token matches
4288 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4289 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4290 return $this->matchEditToken( $val, $salt, $request, $maxage );
4294 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4295 * mail to the user's given address.
4297 * @param string $type Message to send, either "created", "changed" or "set"
4300 public function sendConfirmationMail( $type = 'created' ) {
4302 $expiration = null; // gets passed-by-ref and defined in next line.
4303 $token = $this->confirmationToken( $expiration );
4304 $url = $this->confirmationTokenUrl( $token );
4305 $invalidateURL = $this->invalidationTokenUrl( $token );
4306 $this->saveSettings();
4308 if ( $type == 'created' ||
$type === false ) {
4309 $message = 'confirmemail_body';
4310 } elseif ( $type === true ) {
4311 $message = 'confirmemail_body_changed';
4313 // Messages: confirmemail_body_changed, confirmemail_body_set
4314 $message = 'confirmemail_body_' . $type;
4317 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4318 wfMessage( $message,
4319 $this->getRequest()->getIP(),
4322 $wgLang->userTimeAndDate( $expiration, $this ),
4324 $wgLang->userDate( $expiration, $this ),
4325 $wgLang->userTime( $expiration, $this ) )->text() );
4329 * Send an e-mail to this user's account. Does not check for
4330 * confirmed status or validity.
4332 * @param string $subject Message subject
4333 * @param string $body Message body
4334 * @param User|null $from Optional sending user; if unspecified, default
4335 * $wgPasswordSender will be used.
4336 * @param string $replyto Reply-To address
4339 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4340 global $wgPasswordSender;
4342 if ( $from instanceof User
) {
4343 $sender = MailAddress
::newFromUser( $from );
4345 $sender = new MailAddress( $wgPasswordSender,
4346 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4348 $to = MailAddress
::newFromUser( $this );
4350 return UserMailer
::send( $to, $sender, $subject, $body, [
4351 'replyTo' => $replyto,
4356 * Generate, store, and return a new e-mail confirmation code.
4357 * A hash (unsalted, since it's used as a key) is stored.
4359 * @note Call saveSettings() after calling this function to commit
4360 * this change to the database.
4362 * @param string &$expiration Accepts the expiration time
4363 * @return string New token
4365 protected function confirmationToken( &$expiration ) {
4366 global $wgUserEmailConfirmationTokenExpiry;
4368 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4369 $expiration = wfTimestamp( TS_MW
, $expires );
4371 $token = MWCryptRand
::generateHex( 32 );
4372 $hash = md5( $token );
4373 $this->mEmailToken
= $hash;
4374 $this->mEmailTokenExpires
= $expiration;
4379 * Return a URL the user can use to confirm their email address.
4380 * @param string $token Accepts the email confirmation token
4381 * @return string New token URL
4383 protected function confirmationTokenUrl( $token ) {
4384 return $this->getTokenUrl( 'ConfirmEmail', $token );
4388 * Return a URL the user can use to invalidate their email address.
4389 * @param string $token Accepts the email confirmation token
4390 * @return string New token URL
4392 protected function invalidationTokenUrl( $token ) {
4393 return $this->getTokenUrl( 'InvalidateEmail', $token );
4397 * Internal function to format the e-mail validation/invalidation URLs.
4398 * This uses a quickie hack to use the
4399 * hardcoded English names of the Special: pages, for ASCII safety.
4401 * @note Since these URLs get dropped directly into emails, using the
4402 * short English names avoids insanely long URL-encoded links, which
4403 * also sometimes can get corrupted in some browsers/mailers
4404 * (bug 6957 with Gmail and Internet Explorer).
4406 * @param string $page Special page
4407 * @param string $token Token
4408 * @return string Formatted URL
4410 protected function getTokenUrl( $page, $token ) {
4411 // Hack to bypass localization of 'Special:'
4412 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4413 return $title->getCanonicalURL();
4417 * Mark the e-mail address confirmed.
4419 * @note Call saveSettings() after calling this function to commit the change.
4423 public function confirmEmail() {
4424 // Check if it's already confirmed, so we don't touch the database
4425 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4426 if ( !$this->isEmailConfirmed() ) {
4427 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4428 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4434 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4435 * address if it was already confirmed.
4437 * @note Call saveSettings() after calling this function to commit the change.
4438 * @return bool Returns true
4440 public function invalidateEmail() {
4442 $this->mEmailToken
= null;
4443 $this->mEmailTokenExpires
= null;
4444 $this->setEmailAuthenticationTimestamp( null );
4446 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4451 * Set the e-mail authentication timestamp.
4452 * @param string $timestamp TS_MW timestamp
4454 public function setEmailAuthenticationTimestamp( $timestamp ) {
4456 $this->mEmailAuthenticated
= $timestamp;
4457 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4461 * Is this user allowed to send e-mails within limits of current
4462 * site configuration?
4465 public function canSendEmail() {
4466 global $wgEnableEmail, $wgEnableUserEmail;
4467 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4470 $canSend = $this->isEmailConfirmed();
4471 Hooks
::run( 'UserCanSendEmail', [ &$this, &$canSend ] );
4476 * Is this user allowed to receive e-mails within limits of current
4477 * site configuration?
4480 public function canReceiveEmail() {
4481 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4485 * Is this user's e-mail address valid-looking and confirmed within
4486 * limits of the current site configuration?
4488 * @note If $wgEmailAuthentication is on, this may require the user to have
4489 * confirmed their address by returning a code or using a password
4490 * sent to the address from the wiki.
4494 public function isEmailConfirmed() {
4495 global $wgEmailAuthentication;
4498 if ( Hooks
::run( 'EmailConfirmed', [ &$this, &$confirmed ] ) ) {
4499 if ( $this->isAnon() ) {
4502 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4505 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4515 * Check whether there is an outstanding request for e-mail confirmation.
4518 public function isEmailConfirmationPending() {
4519 global $wgEmailAuthentication;
4520 return $wgEmailAuthentication &&
4521 !$this->isEmailConfirmed() &&
4522 $this->mEmailToken
&&
4523 $this->mEmailTokenExpires
> wfTimestamp();
4527 * Get the timestamp of account creation.
4529 * @return string|bool|null Timestamp of account creation, false for
4530 * non-existent/anonymous user accounts, or null if existing account
4531 * but information is not in database.
4533 public function getRegistration() {
4534 if ( $this->isAnon() ) {
4538 return $this->mRegistration
;
4542 * Get the timestamp of the first edit
4544 * @return string|bool Timestamp of first edit, or false for
4545 * non-existent/anonymous user accounts.
4547 public function getFirstEditTimestamp() {
4548 if ( $this->getId() == 0 ) {
4549 return false; // anons
4551 $dbr = wfGetDB( DB_REPLICA
);
4552 $time = $dbr->selectField( 'revision', 'rev_timestamp',
4553 [ 'rev_user' => $this->getId() ],
4555 [ 'ORDER BY' => 'rev_timestamp ASC' ]
4558 return false; // no edits
4560 return wfTimestamp( TS_MW
, $time );
4564 * Get the permissions associated with a given list of groups
4566 * @param array $groups Array of Strings List of internal group names
4567 * @return array Array of Strings List of permission key names for given groups combined
4569 public static function getGroupPermissions( $groups ) {
4570 global $wgGroupPermissions, $wgRevokePermissions;
4572 // grant every granted permission first
4573 foreach ( $groups as $group ) {
4574 if ( isset( $wgGroupPermissions[$group] ) ) {
4575 $rights = array_merge( $rights,
4576 // array_filter removes empty items
4577 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4580 // now revoke the revoked permissions
4581 foreach ( $groups as $group ) {
4582 if ( isset( $wgRevokePermissions[$group] ) ) {
4583 $rights = array_diff( $rights,
4584 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4587 return array_unique( $rights );
4591 * Get all the groups who have a given permission
4593 * @param string $role Role to check
4594 * @return array Array of Strings List of internal group names with the given permission
4596 public static function getGroupsWithPermission( $role ) {
4597 global $wgGroupPermissions;
4598 $allowedGroups = [];
4599 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4600 if ( self
::groupHasPermission( $group, $role ) ) {
4601 $allowedGroups[] = $group;
4604 return $allowedGroups;
4608 * Check, if the given group has the given permission
4610 * If you're wanting to check whether all users have a permission, use
4611 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4615 * @param string $group Group to check
4616 * @param string $role Role to check
4619 public static function groupHasPermission( $group, $role ) {
4620 global $wgGroupPermissions, $wgRevokePermissions;
4621 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4622 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4626 * Check if all users may be assumed to have the given permission
4628 * We generally assume so if the right is granted to '*' and isn't revoked
4629 * on any group. It doesn't attempt to take grants or other extension
4630 * limitations on rights into account in the general case, though, as that
4631 * would require it to always return false and defeat the purpose.
4632 * Specifically, session-based rights restrictions (such as OAuth or bot
4633 * passwords) are applied based on the current session.
4636 * @param string $right Right to check
4639 public static function isEveryoneAllowed( $right ) {
4640 global $wgGroupPermissions, $wgRevokePermissions;
4643 // Use the cached results, except in unit tests which rely on
4644 // being able change the permission mid-request
4645 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
4646 return $cache[$right];
4649 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
4650 $cache[$right] = false;
4654 // If it's revoked anywhere, then everyone doesn't have it
4655 foreach ( $wgRevokePermissions as $rights ) {
4656 if ( isset( $rights[$right] ) && $rights[$right] ) {
4657 $cache[$right] = false;
4662 // Remove any rights that aren't allowed to the global-session user,
4663 // unless there are no sessions for this endpoint.
4664 if ( !defined( 'MW_NO_SESSION' ) ) {
4665 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
4666 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
4667 $cache[$right] = false;
4672 // Allow extensions to say false
4673 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
4674 $cache[$right] = false;
4678 $cache[$right] = true;
4683 * Get the localized descriptive name for a group, if it exists
4685 * @param string $group Internal group name
4686 * @return string Localized descriptive group name
4688 public static function getGroupName( $group ) {
4689 $msg = wfMessage( "group-$group" );
4690 return $msg->isBlank() ?
$group : $msg->text();
4694 * Get the localized descriptive name for a member of a group, if it exists
4696 * @param string $group Internal group name
4697 * @param string $username Username for gender (since 1.19)
4698 * @return string Localized name for group member
4700 public static function getGroupMember( $group, $username = '#' ) {
4701 $msg = wfMessage( "group-$group-member", $username );
4702 return $msg->isBlank() ?
$group : $msg->text();
4706 * Return the set of defined explicit groups.
4707 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4708 * are not included, as they are defined automatically, not in the database.
4709 * @return array Array of internal group names
4711 public static function getAllGroups() {
4712 global $wgGroupPermissions, $wgRevokePermissions;
4714 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4715 self
::getImplicitGroups()
4720 * Get a list of all available permissions.
4721 * @return string[] Array of permission names
4723 public static function getAllRights() {
4724 if ( self
::$mAllRights === false ) {
4725 global $wgAvailableRights;
4726 if ( count( $wgAvailableRights ) ) {
4727 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
4729 self
::$mAllRights = self
::$mCoreRights;
4731 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
4733 return self
::$mAllRights;
4737 * Get a list of implicit groups
4738 * @return array Array of Strings Array of internal group names
4740 public static function getImplicitGroups() {
4741 global $wgImplicitGroups;
4743 $groups = $wgImplicitGroups;
4744 # Deprecated, use $wgImplicitGroups instead
4745 Hooks
::run( 'UserGetImplicitGroups', [ &$groups ], '1.25' );
4751 * Get the title of a page describing a particular group
4753 * @param string $group Internal group name
4754 * @return Title|bool Title of the page if it exists, false otherwise
4756 public static function getGroupPage( $group ) {
4757 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
4758 if ( $msg->exists() ) {
4759 $title = Title
::newFromText( $msg->text() );
4760 if ( is_object( $title ) ) {
4768 * Create a link to the group in HTML, if available;
4769 * else return the group name.
4771 * @param string $group Internal name of the group
4772 * @param string $text The text of the link
4773 * @return string HTML link to the group
4775 public static function makeGroupLinkHTML( $group, $text = '' ) {
4776 if ( $text == '' ) {
4777 $text = self
::getGroupName( $group );
4779 $title = self
::getGroupPage( $group );
4781 return Linker
::link( $title, htmlspecialchars( $text ) );
4783 return htmlspecialchars( $text );
4788 * Create a link to the group in Wikitext, if available;
4789 * else return the group name.
4791 * @param string $group Internal name of the group
4792 * @param string $text The text of the link
4793 * @return string Wikilink to the group
4795 public static function makeGroupLinkWiki( $group, $text = '' ) {
4796 if ( $text == '' ) {
4797 $text = self
::getGroupName( $group );
4799 $title = self
::getGroupPage( $group );
4801 $page = $title->getFullText();
4802 return "[[$page|$text]]";
4809 * Returns an array of the groups that a particular group can add/remove.
4811 * @param string $group The group to check for whether it can add/remove
4812 * @return array Array( 'add' => array( addablegroups ),
4813 * 'remove' => array( removablegroups ),
4814 * 'add-self' => array( addablegroups to self),
4815 * 'remove-self' => array( removable groups from self) )
4817 public static function changeableByGroup( $group ) {
4818 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4827 if ( empty( $wgAddGroups[$group] ) ) {
4828 // Don't add anything to $groups
4829 } elseif ( $wgAddGroups[$group] === true ) {
4830 // You get everything
4831 $groups['add'] = self
::getAllGroups();
4832 } elseif ( is_array( $wgAddGroups[$group] ) ) {
4833 $groups['add'] = $wgAddGroups[$group];
4836 // Same thing for remove
4837 if ( empty( $wgRemoveGroups[$group] ) ) {
4839 } elseif ( $wgRemoveGroups[$group] === true ) {
4840 $groups['remove'] = self
::getAllGroups();
4841 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4842 $groups['remove'] = $wgRemoveGroups[$group];
4845 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4846 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
4847 foreach ( $wgGroupsAddToSelf as $key => $value ) {
4848 if ( is_int( $key ) ) {
4849 $wgGroupsAddToSelf['user'][] = $value;
4854 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
4855 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4856 if ( is_int( $key ) ) {
4857 $wgGroupsRemoveFromSelf['user'][] = $value;
4862 // Now figure out what groups the user can add to him/herself
4863 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
4865 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
4866 // No idea WHY this would be used, but it's there
4867 $groups['add-self'] = User
::getAllGroups();
4868 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4869 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4872 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4874 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4875 $groups['remove-self'] = User
::getAllGroups();
4876 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4877 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4884 * Returns an array of groups that this user can add and remove
4885 * @return array Array( 'add' => array( addablegroups ),
4886 * 'remove' => array( removablegroups ),
4887 * 'add-self' => array( addablegroups to self),
4888 * 'remove-self' => array( removable groups from self) )
4890 public function changeableGroups() {
4891 if ( $this->isAllowed( 'userrights' ) ) {
4892 // This group gives the right to modify everything (reverse-
4893 // compatibility with old "userrights lets you change
4895 // Using array_merge to make the groups reindexed
4896 $all = array_merge( User
::getAllGroups() );
4905 // Okay, it's not so simple, we will have to go through the arrays
4912 $addergroups = $this->getEffectiveGroups();
4914 foreach ( $addergroups as $addergroup ) {
4915 $groups = array_merge_recursive(
4916 $groups, $this->changeableByGroup( $addergroup )
4918 $groups['add'] = array_unique( $groups['add'] );
4919 $groups['remove'] = array_unique( $groups['remove'] );
4920 $groups['add-self'] = array_unique( $groups['add-self'] );
4921 $groups['remove-self'] = array_unique( $groups['remove-self'] );
4927 * Deferred version of incEditCountImmediate()
4929 public function incEditCount() {
4930 wfGetDB( DB_MASTER
)->onTransactionPreCommitOrIdle( function() {
4931 $this->incEditCountImmediate();
4936 * Increment the user's edit-count field.
4937 * Will have no effect for anonymous users.
4940 public function incEditCountImmediate() {
4941 if ( $this->isAnon() ) {
4945 $dbw = wfGetDB( DB_MASTER
);
4946 // No rows will be "affected" if user_editcount is NULL
4949 [ 'user_editcount=user_editcount+1' ],
4950 [ 'user_id' => $this->getId(), 'user_editcount IS NOT NULL' ],
4953 // Lazy initialization check...
4954 if ( $dbw->affectedRows() == 0 ) {
4955 // Now here's a goddamn hack...
4956 $dbr = wfGetDB( DB_REPLICA
);
4957 if ( $dbr !== $dbw ) {
4958 // If we actually have a replica DB server, the count is
4959 // at least one behind because the current transaction
4960 // has not been committed and replicated.
4961 $this->mEditCount
= $this->initEditCount( 1 );
4963 // But if DB_REPLICA is selecting the master, then the
4964 // count we just read includes the revision that was
4965 // just added in the working transaction.
4966 $this->mEditCount
= $this->initEditCount();
4969 if ( $this->mEditCount
=== null ) {
4970 $this->getEditCount();
4971 $dbr = wfGetDB( DB_REPLICA
);
4972 $this->mEditCount +
= ( $dbr !== $dbw ) ?
1 : 0;
4974 $this->mEditCount++
;
4977 // Edit count in user cache too
4978 $this->invalidateCache();
4982 * Initialize user_editcount from data out of the revision table
4984 * @param int $add Edits to add to the count from the revision table
4985 * @return int Number of edits
4987 protected function initEditCount( $add = 0 ) {
4988 // Pull from a replica DB to be less cruel to servers
4989 // Accuracy isn't the point anyway here
4990 $dbr = wfGetDB( DB_REPLICA
);
4991 $count = (int)$dbr->selectField(
4994 [ 'rev_user' => $this->getId() ],
4997 $count = $count +
$add;
4999 $dbw = wfGetDB( DB_MASTER
);
5002 [ 'user_editcount' => $count ],
5003 [ 'user_id' => $this->getId() ],
5011 * Get the description of a given right
5013 * @param string $right Right to query
5014 * @return string Localized description of the right
5016 public static function getRightDescription( $right ) {
5017 $key = "right-$right";
5018 $msg = wfMessage( $key );
5019 return $msg->isBlank() ?
$right : $msg->text();
5023 * Make a new-style password hash
5025 * @param string $password Plain-text password
5026 * @param bool|string $salt Optional salt, may be random or the user ID.
5027 * If unspecified or false, will generate one automatically
5028 * @return string Password hash
5029 * @deprecated since 1.24, use Password class
5031 public static function crypt( $password, $salt = false ) {
5032 wfDeprecated( __METHOD__
, '1.24' );
5033 $passwordFactory = new PasswordFactory();
5034 $passwordFactory->init( RequestContext
::getMain()->getConfig() );
5035 $hash = $passwordFactory->newFromPlaintext( $password );
5036 return $hash->toString();
5040 * Compare a password hash with a plain-text password. Requires the user
5041 * ID if there's a chance that the hash is an old-style hash.
5043 * @param string $hash Password hash
5044 * @param string $password Plain-text password to compare
5045 * @param string|bool $userId User ID for old-style password salt
5048 * @deprecated since 1.24, use Password class
5050 public static function comparePasswords( $hash, $password, $userId = false ) {
5051 wfDeprecated( __METHOD__
, '1.24' );
5053 // Check for *really* old password hashes that don't even have a type
5054 // The old hash format was just an md5 hex hash, with no type information
5055 if ( preg_match( '/^[0-9a-f]{32}$/', $hash ) ) {
5056 global $wgPasswordSalt;
5057 if ( $wgPasswordSalt ) {
5058 $password = ":B:{$userId}:{$hash}";
5060 $password = ":A:{$hash}";
5064 $passwordFactory = new PasswordFactory();
5065 $passwordFactory->init( RequestContext
::getMain()->getConfig() );
5066 $hash = $passwordFactory->newFromCiphertext( $hash );
5067 return $hash->equals( $password );
5071 * Add a newuser log entry for this user.
5072 * Before 1.19 the return value was always true.
5074 * @deprecated since 1.27, AuthManager handles logging
5075 * @param string|bool $action Account creation type.
5076 * - String, one of the following values:
5077 * - 'create' for an anonymous user creating an account for himself.
5078 * This will force the action's performer to be the created user itself,
5079 * no matter the value of $wgUser
5080 * - 'create2' for a logged in user creating an account for someone else
5081 * - 'byemail' when the created user will receive its password by e-mail
5082 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5083 * - Boolean means whether the account was created by e-mail (deprecated):
5084 * - true will be converted to 'byemail'
5085 * - false will be converted to 'create' if this object is the same as
5086 * $wgUser and to 'create2' otherwise
5087 * @param string $reason User supplied reason
5090 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5091 return true; // disabled
5095 * Add an autocreate newuser log entry for this user
5096 * Used by things like CentralAuth and perhaps other authplugins.
5097 * Consider calling addNewUserLogEntry() directly instead.
5099 * @deprecated since 1.27, AuthManager handles logging
5102 public function addNewUserLogEntryAutoCreate() {
5103 $this->addNewUserLogEntry( 'autocreate' );
5109 * Load the user options either from cache, the database or an array
5111 * @param array $data Rows for the current user out of the user_properties table
5113 protected function loadOptions( $data = null ) {
5118 if ( $this->mOptionsLoaded
) {
5122 $this->mOptions
= self
::getDefaultOptions();
5124 if ( !$this->getId() ) {
5125 // For unlogged-in users, load language/variant options from request.
5126 // There's no need to do it for logged-in users: they can set preferences,
5127 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5128 // so don't override user's choice (especially when the user chooses site default).
5129 $variant = $wgContLang->getDefaultVariant();
5130 $this->mOptions
['variant'] = $variant;
5131 $this->mOptions
['language'] = $variant;
5132 $this->mOptionsLoaded
= true;
5136 // Maybe load from the object
5137 if ( !is_null( $this->mOptionOverrides
) ) {
5138 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5139 foreach ( $this->mOptionOverrides
as $key => $value ) {
5140 $this->mOptions
[$key] = $value;
5143 if ( !is_array( $data ) ) {
5144 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5145 // Load from database
5146 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5147 ?
wfGetDB( DB_MASTER
)
5148 : wfGetDB( DB_REPLICA
);
5150 $res = $dbr->select(
5152 [ 'up_property', 'up_value' ],
5153 [ 'up_user' => $this->getId() ],
5157 $this->mOptionOverrides
= [];
5159 foreach ( $res as $row ) {
5160 $data[$row->up_property
] = $row->up_value
;
5163 foreach ( $data as $property => $value ) {
5164 $this->mOptionOverrides
[$property] = $value;
5165 $this->mOptions
[$property] = $value;
5169 $this->mOptionsLoaded
= true;
5171 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5175 * Saves the non-default options for this user, as previously set e.g. via
5176 * setOption(), in the database's "user_properties" (preferences) table.
5177 * Usually used via saveSettings().
5179 protected function saveOptions() {
5180 $this->loadOptions();
5182 // Not using getOptions(), to keep hidden preferences in database
5183 $saveOptions = $this->mOptions
;
5185 // Allow hooks to abort, for instance to save to a global profile.
5186 // Reset options to default state before saving.
5187 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5191 $userId = $this->getId();
5193 $insert_rows = []; // all the new preference rows
5194 foreach ( $saveOptions as $key => $value ) {
5195 // Don't bother storing default values
5196 $defaultOption = self
::getDefaultOption( $key );
5197 if ( ( $defaultOption === null && $value !== false && $value !== null )
5198 ||
$value != $defaultOption
5201 'up_user' => $userId,
5202 'up_property' => $key,
5203 'up_value' => $value,
5208 $dbw = wfGetDB( DB_MASTER
);
5210 $res = $dbw->select( 'user_properties',
5211 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5213 // Find prior rows that need to be removed or updated. These rows will
5214 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5216 foreach ( $res as $row ) {
5217 if ( !isset( $saveOptions[$row->up_property
] )
5218 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5220 $keysDelete[] = $row->up_property
;
5224 if ( count( $keysDelete ) ) {
5225 // Do the DELETE by PRIMARY KEY for prior rows.
5226 // In the past a very large portion of calls to this function are for setting
5227 // 'rememberpassword' for new accounts (a preference that has since been removed).
5228 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5229 // caused gap locks on [max user ID,+infinity) which caused high contention since
5230 // updates would pile up on each other as they are for higher (newer) user IDs.
5231 // It might not be necessary these days, but it shouldn't hurt either.
5232 $dbw->delete( 'user_properties',
5233 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5235 // Insert the new preference rows
5236 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5240 * Lazily instantiate and return a factory object for making passwords
5242 * @deprecated since 1.27, create a PasswordFactory directly instead
5243 * @return PasswordFactory
5245 public static function getPasswordFactory() {
5246 wfDeprecated( __METHOD__
, '1.27' );
5247 $ret = new PasswordFactory();
5248 $ret->init( RequestContext
::getMain()->getConfig() );
5253 * Provide an array of HTML5 attributes to put on an input element
5254 * intended for the user to enter a new password. This may include
5255 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
5257 * Do *not* use this when asking the user to enter his current password!
5258 * Regardless of configuration, users may have invalid passwords for whatever
5259 * reason (e.g., they were set before requirements were tightened up).
5260 * Only use it when asking for a new password, like on account creation or
5263 * Obviously, you still need to do server-side checking.
5265 * NOTE: A combination of bugs in various browsers means that this function
5266 * actually just returns array() unconditionally at the moment. May as
5267 * well keep it around for when the browser bugs get fixed, though.
5269 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
5271 * @deprecated since 1.27
5272 * @return array Array of HTML attributes suitable for feeding to
5273 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
5274 * That will get confused by the boolean attribute syntax used.)
5276 public static function passwordChangeInputAttribs() {
5277 global $wgMinimalPasswordLength;
5279 if ( $wgMinimalPasswordLength == 0 ) {
5283 # Note that the pattern requirement will always be satisfied if the
5284 # input is empty, so we need required in all cases.
5286 # @todo FIXME: Bug 23769: This needs to not claim the password is required
5287 # if e-mail confirmation is being used. Since HTML5 input validation
5288 # is b0rked anyway in some browsers, just return nothing. When it's
5289 # re-enabled, fix this code to not output required for e-mail
5291 # $ret = array( 'required' );
5294 # We can't actually do this right now, because Opera 9.6 will print out
5295 # the entered password visibly in its error message! When other
5296 # browsers add support for this attribute, or Opera fixes its support,
5297 # we can add support with a version check to avoid doing this on Opera
5298 # versions where it will be a problem. Reported to Opera as
5299 # DSK-262266, but they don't have a public bug tracker for us to follow.
5301 if ( $wgMinimalPasswordLength > 1 ) {
5302 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
5303 $ret['title'] = wfMessage( 'passwordtooshort' )
5304 ->numParams( $wgMinimalPasswordLength )->text();
5312 * Return the list of user fields that should be selected to create
5313 * a new user object.
5316 public static function selectFields() {
5324 'user_email_authenticated',
5326 'user_email_token_expires',
5327 'user_registration',
5333 * Factory function for fatal permission-denied errors
5336 * @param string $permission User right required
5339 static function newFatalPermissionDeniedStatus( $permission ) {
5342 $groups = array_map(
5343 [ 'User', 'makeGroupLinkWiki' ],
5344 User
::getGroupsWithPermission( $permission )
5348 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5350 return Status
::newFatal( 'badaccess-group0' );
5355 * Get a new instance of this user that was loaded from the master via a locking read
5357 * Use this instead of the main context User when updating that user. This avoids races
5358 * where that user was loaded from a replica DB or even the master but without proper locks.
5360 * @return User|null Returns null if the user was not found in the DB
5363 public function getInstanceForUpdate() {
5364 if ( !$this->getId() ) {
5365 return null; // anon
5368 $user = self
::newFromId( $this->getId() );
5369 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5377 * Checks if two user objects point to the same user.
5383 public function equals( User
$user ) {
5384 return $this->getName() === $user->getName();