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 ) {
477 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_SLAVE
) );
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;
492 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'version' => self
::VERSION
]
495 // Restore from cache
496 foreach ( self
::$mCacheVars as $name ) {
497 $this->$name = $data[$name];
503 /** @name newFrom*() static factory methods */
507 * Static factory method for creation from username.
509 * This is slightly less efficient than newFromId(), so use newFromId() if
510 * you have both an ID and a name handy.
512 * @param string $name Username, validated by Title::newFromText()
513 * @param string|bool $validate Validate username. Takes the same parameters as
514 * User::getCanonicalName(), except that true is accepted as an alias
515 * for 'valid', for BC.
517 * @return User|bool User object, or false if the username is invalid
518 * (e.g. if it contains illegal characters or is an IP address). If the
519 * username is not present in the database, the result will be a user object
520 * with a name, zero user ID and default settings.
522 public static function newFromName( $name, $validate = 'valid' ) {
523 if ( $validate === true ) {
526 $name = self
::getCanonicalName( $name, $validate );
527 if ( $name === false ) {
530 // Create unloaded user object
534 $u->setItemLoaded( 'name' );
540 * Static factory method for creation from a given user ID.
542 * @param int $id Valid user ID
543 * @return User The corresponding User object
545 public static function newFromId( $id ) {
549 $u->setItemLoaded( 'id' );
554 * Factory method to fetch whichever user has a given email confirmation code.
555 * This code is generated when an account is created or its e-mail address
558 * If the code is invalid or has expired, returns NULL.
560 * @param string $code Confirmation code
561 * @param int $flags User::READ_* bitfield
564 public static function newFromConfirmationCode( $code, $flags = 0 ) {
565 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
566 ?
wfGetDB( DB_MASTER
)
567 : wfGetDB( DB_SLAVE
);
569 $id = $db->selectField(
573 'user_email_token' => md5( $code ),
574 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
578 return $id ? User
::newFromId( $id ) : null;
582 * Create a new user object using data from session. If the login
583 * credentials are invalid, the result is an anonymous user.
585 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
588 public static function newFromSession( WebRequest
$request = null ) {
590 $user->mFrom
= 'session';
591 $user->mRequest
= $request;
596 * Create a new user object from a user row.
597 * The row should have the following fields from the user table in it:
598 * - either user_name or user_id to load further data if needed (or both)
600 * - all other fields (email, etc.)
601 * It is useless to provide the remaining fields if either user_id,
602 * user_name and user_real_name are not provided because the whole row
603 * will be loaded once more from the database when accessing them.
605 * @param stdClass $row A row from the user table
606 * @param array $data Further data to load into the object (see User::loadFromRow for valid keys)
609 public static function newFromRow( $row, $data = null ) {
611 $user->loadFromRow( $row, $data );
616 * Static factory method for creation of a "system" user from username.
618 * A "system" user is an account that's used to attribute logged actions
619 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
620 * might include the 'Maintenance script' or 'Conversion script' accounts
621 * used by various scripts in the maintenance/ directory or accounts such
622 * as 'MediaWiki message delivery' used by the MassMessage extension.
624 * This can optionally create the user if it doesn't exist, and "steal" the
625 * account if it does exist.
627 * "Stealing" an existing user is intended to make it impossible for normal
628 * authentication processes to use the account, effectively disabling the
629 * account for normal use:
630 * - Email is invalidated, to prevent account recovery by emailing a
631 * temporary password and to disassociate the account from the existing
633 * - The token is set to a magic invalid value, to kill existing sessions
634 * and to prevent $this->setToken() calls from resetting the token to a
636 * - SessionManager is instructed to prevent new sessions for the user, to
637 * do things like deauthorizing OAuth consumers.
638 * - AuthManager is instructed to revoke access, to invalidate or remove
639 * passwords and other credentials.
641 * @param string $name Username
642 * @param array $options Options are:
643 * - validate: As for User::getCanonicalName(), default 'valid'
644 * - create: Whether to create the user if it doesn't already exist, default true
645 * - steal: Whether to "disable" the account for normal use if it already
646 * exists, default false
650 public static function newSystemUser( $name, $options = [] ) {
652 'validate' => 'valid',
657 $name = self
::getCanonicalName( $name, $options['validate'] );
658 if ( $name === false ) {
662 $fields = self
::selectFields();
664 $dbw = wfGetDB( DB_MASTER
);
665 $row = $dbw->selectRow(
668 [ 'user_name' => $name ],
672 // No user. Create it?
673 return $options['create'] ? self
::createNew( $name ) : null;
675 $user = self
::newFromRow( $row );
677 // A user is considered to exist as a non-system user if it can
678 // authenticate, or has an email set, or has a non-invalid token.
679 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
680 AuthManager
::singleton()->userCanAuthenticate( $name )
682 // User exists. Steal it?
683 if ( !$options['steal'] ) {
687 AuthManager
::singleton()->revokeAccessForUser( $name );
689 $user->invalidateEmail();
690 $user->mToken
= self
::INVALID_TOKEN
;
691 $user->saveSettings();
692 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
701 * Get the username corresponding to a given user ID
702 * @param int $id User ID
703 * @return string|bool The corresponding username
705 public static function whoIs( $id ) {
706 return UserCache
::singleton()->getProp( $id, 'name' );
710 * Get the real name of a user given their user ID
712 * @param int $id User ID
713 * @return string|bool The corresponding user's real name
715 public static function whoIsReal( $id ) {
716 return UserCache
::singleton()->getProp( $id, 'real_name' );
720 * Get database id given a user name
721 * @param string $name Username
722 * @param integer $flags User::READ_* constant bitfield
723 * @return int|null The corresponding user's ID, or null if user is nonexistent
725 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
726 $nt = Title
::makeTitleSafe( NS_USER
, $name );
727 if ( is_null( $nt ) ) {
732 if ( !( $flags & self
::READ_LATEST
) && isset( self
::$idCacheByName[$name] ) ) {
733 return self
::$idCacheByName[$name];
736 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
737 $db = wfGetDB( $index );
742 [ 'user_name' => $nt->getText() ],
747 if ( $s === false ) {
750 $result = $s->user_id
;
753 self
::$idCacheByName[$name] = $result;
755 if ( count( self
::$idCacheByName ) > 1000 ) {
756 self
::$idCacheByName = [];
763 * Reset the cache used in idFromName(). For use in tests.
765 public static function resetIdByNameCache() {
766 self
::$idCacheByName = [];
770 * Does the string match an anonymous IP address?
772 * This function exists for username validation, in order to reject
773 * usernames which are similar in form to IP addresses. Strings such
774 * as 300.300.300.300 will return true because it looks like an IP
775 * address, despite not being strictly valid.
777 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
778 * address because the usemod software would "cloak" anonymous IP
779 * addresses like this, if we allowed accounts like this to be created
780 * new users could get the old edits of these anonymous users.
782 * @param string $name Name to match
785 public static function isIP( $name ) {
786 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
787 || IP
::isIPv6( $name );
791 * Is the input a valid username?
793 * Checks if the input is a valid username, we don't want an empty string,
794 * an IP address, anything that contains slashes (would mess up subpages),
795 * is longer than the maximum allowed username size or doesn't begin with
798 * @param string $name Name to match
801 public static function isValidUserName( $name ) {
802 global $wgContLang, $wgMaxNameChars;
805 || User
::isIP( $name )
806 ||
strpos( $name, '/' ) !== false
807 ||
strlen( $name ) > $wgMaxNameChars
808 ||
$name != $wgContLang->ucfirst( $name )
813 // Ensure that the name can't be misresolved as a different title,
814 // such as with extra namespace keys at the start.
815 $parsed = Title
::newFromText( $name );
816 if ( is_null( $parsed )
817 ||
$parsed->getNamespace()
818 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
822 // Check an additional blacklist of troublemaker characters.
823 // Should these be merged into the title char list?
824 $unicodeBlacklist = '/[' .
825 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
826 '\x{00a0}' . # non-breaking space
827 '\x{2000}-\x{200f}' . # various whitespace
828 '\x{2028}-\x{202f}' . # breaks and control chars
829 '\x{3000}' . # ideographic space
830 '\x{e000}-\x{f8ff}' . # private use
832 if ( preg_match( $unicodeBlacklist, $name ) ) {
840 * Usernames which fail to pass this function will be blocked
841 * from user login and new account registrations, but may be used
842 * internally by batch processes.
844 * If an account already exists in this form, login will be blocked
845 * by a failure to pass this function.
847 * @param string $name Name to match
850 public static function isUsableName( $name ) {
851 global $wgReservedUsernames;
852 // Must be a valid username, obviously ;)
853 if ( !self
::isValidUserName( $name ) ) {
857 static $reservedUsernames = false;
858 if ( !$reservedUsernames ) {
859 $reservedUsernames = $wgReservedUsernames;
860 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
863 // Certain names may be reserved for batch processes.
864 foreach ( $reservedUsernames as $reserved ) {
865 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
866 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
868 if ( $reserved == $name ) {
876 * Return the users who are members of the given group(s). In case of multiple groups,
877 * users who are members of at least one of them are returned.
879 * @param string|array $groups A single group name or an array of group names
880 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
881 * records; larger values are ignored.
882 * @param int $after ID the user to start after
883 * @return UserArrayFromResult
885 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
886 if ( $groups === [] ) {
887 return UserArrayFromResult
::newFromIDs( [] );
890 $groups = array_unique( (array)$groups );
891 $limit = min( 5000, $limit );
893 $conds = [ 'ug_group' => $groups ];
894 if ( $after !== null ) {
895 $conds[] = 'ug_user > ' . (int)$after;
898 $dbr = wfGetDB( DB_SLAVE
);
899 $ids = $dbr->selectFieldValues(
906 'ORDER BY' => 'ug_user',
910 return UserArray
::newFromIDs( $ids );
914 * Usernames which fail to pass this function will be blocked
915 * from new account registrations, but may be used internally
916 * either by batch processes or by user accounts which have
917 * already been created.
919 * Additional blacklisting may be added here rather than in
920 * isValidUserName() to avoid disrupting existing accounts.
922 * @param string $name String to match
925 public static function isCreatableName( $name ) {
926 global $wgInvalidUsernameCharacters;
928 // Ensure that the username isn't longer than 235 bytes, so that
929 // (at least for the builtin skins) user javascript and css files
930 // will work. (bug 23080)
931 if ( strlen( $name ) > 235 ) {
932 wfDebugLog( 'username', __METHOD__
.
933 ": '$name' invalid due to length" );
937 // Preg yells if you try to give it an empty string
938 if ( $wgInvalidUsernameCharacters !== '' ) {
939 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
940 wfDebugLog( 'username', __METHOD__
.
941 ": '$name' invalid due to wgInvalidUsernameCharacters" );
946 return self
::isUsableName( $name );
950 * Is the input a valid password for this user?
952 * @param string $password Desired password
955 public function isValidPassword( $password ) {
956 // simple boolean wrapper for getPasswordValidity
957 return $this->getPasswordValidity( $password ) === true;
961 * Given unvalidated password input, return error message on failure.
963 * @param string $password Desired password
964 * @return bool|string|array True on success, string or array of error message on failure
966 public function getPasswordValidity( $password ) {
967 $result = $this->checkPasswordValidity( $password );
968 if ( $result->isGood() ) {
972 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
973 $messages[] = $error['message'];
975 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
976 $messages[] = $warning['message'];
978 if ( count( $messages ) === 1 ) {
986 * Check if this is a valid password for this user
988 * Create a Status object based on the password's validity.
989 * The Status should be set to fatal if the user should not
990 * be allowed to log in, and should have any errors that
991 * would block changing the password.
993 * If the return value of this is not OK, the password
994 * should not be checked. If the return value is not Good,
995 * the password can be checked, but the user should not be
996 * able to set their password to this.
998 * @param string $password Desired password
999 * @param string $purpose one of 'login', 'create', 'reset'
1003 public function checkPasswordValidity( $password, $purpose = 'login' ) {
1004 global $wgPasswordPolicy;
1006 $upp = new UserPasswordPolicy(
1007 $wgPasswordPolicy['policies'],
1008 $wgPasswordPolicy['checks']
1011 $status = Status
::newGood();
1012 $result = false; // init $result to false for the internal checks
1014 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1015 $status->error( $result );
1019 if ( $result === false ) {
1020 $status->merge( $upp->checkUserPassword( $this, $password, $purpose ) );
1022 } elseif ( $result === true ) {
1025 $status->error( $result );
1026 return $status; // the isValidPassword hook set a string $result and returned true
1031 * Given unvalidated user input, return a canonical username, or false if
1032 * the username is invalid.
1033 * @param string $name User input
1034 * @param string|bool $validate Type of validation to use:
1035 * - false No validation
1036 * - 'valid' Valid for batch processes
1037 * - 'usable' Valid for batch processes and login
1038 * - 'creatable' Valid for batch processes, login and account creation
1040 * @throws InvalidArgumentException
1041 * @return bool|string
1043 public static function getCanonicalName( $name, $validate = 'valid' ) {
1044 // Force usernames to capital
1046 $name = $wgContLang->ucfirst( $name );
1048 # Reject names containing '#'; these will be cleaned up
1049 # with title normalisation, but then it's too late to
1051 if ( strpos( $name, '#' ) !== false ) {
1055 // Clean up name according to title rules,
1056 // but only when validation is requested (bug 12654)
1057 $t = ( $validate !== false ) ?
1058 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1059 // Check for invalid titles
1060 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1064 // Reject various classes of invalid names
1065 $name = AuthManager
::callLegacyAuthPlugin(
1066 'getCanonicalName', [ $t->getText() ], $t->getText()
1069 switch ( $validate ) {
1073 if ( !User
::isValidUserName( $name ) ) {
1078 if ( !User
::isUsableName( $name ) ) {
1083 if ( !User
::isCreatableName( $name ) ) {
1088 throw new InvalidArgumentException(
1089 'Invalid parameter value for $validate in ' . __METHOD__
);
1095 * Count the number of edits of a user
1097 * @param int $uid User ID to check
1098 * @return int The user's edit count
1100 * @deprecated since 1.21 in favour of User::getEditCount
1102 public static function edits( $uid ) {
1103 wfDeprecated( __METHOD__
, '1.21' );
1104 $user = self
::newFromId( $uid );
1105 return $user->getEditCount();
1109 * Return a random password.
1111 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1112 * @return string New random password
1114 public static function randomPassword() {
1115 global $wgMinimalPasswordLength;
1116 return PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1120 * Set cached properties to default.
1122 * @note This no longer clears uncached lazy-initialised properties;
1123 * the constructor does that instead.
1125 * @param string|bool $name
1127 public function loadDefaults( $name = false ) {
1129 $this->mName
= $name;
1130 $this->mRealName
= '';
1132 $this->mOptionOverrides
= null;
1133 $this->mOptionsLoaded
= false;
1135 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1136 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1137 if ( $loggedOut !== 0 ) {
1138 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1140 $this->mTouched
= '1'; # Allow any pages to be cached
1143 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1144 $this->mEmailAuthenticated
= null;
1145 $this->mEmailToken
= '';
1146 $this->mEmailTokenExpires
= null;
1147 $this->mRegistration
= wfTimestamp( TS_MW
);
1148 $this->mGroups
= [];
1150 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1154 * Return whether an item has been loaded.
1156 * @param string $item Item to check. Current possibilities:
1160 * @param string $all 'all' to check if the whole object has been loaded
1161 * or any other string to check if only the item is available (e.g.
1165 public function isItemLoaded( $item, $all = 'all' ) {
1166 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1167 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1171 * Set that an item has been loaded
1173 * @param string $item
1175 protected function setItemLoaded( $item ) {
1176 if ( is_array( $this->mLoadedItems
) ) {
1177 $this->mLoadedItems
[$item] = true;
1182 * Load user data from the session.
1184 * @return bool True if the user is logged in, false otherwise.
1186 private function loadFromSession() {
1189 Hooks
::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1190 if ( $result !== null ) {
1194 // MediaWiki\Session\Session already did the necessary authentication of the user
1195 // returned here, so just use it if applicable.
1196 $session = $this->getRequest()->getSession();
1197 $user = $session->getUser();
1198 if ( $user->isLoggedIn() ) {
1199 $this->loadFromUserObject( $user );
1200 // Other code expects these to be set in the session, so set them.
1201 $session->set( 'wsUserID', $this->getId() );
1202 $session->set( 'wsUserName', $this->getName() );
1203 $session->set( 'wsToken', $this->getToken() );
1211 * Load user and user_group data from the database.
1212 * $this->mId must be set, this is how the user is identified.
1214 * @param integer $flags User::READ_* constant bitfield
1215 * @return bool True if the user exists, false if the user is anonymous
1217 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1219 $this->mId
= intval( $this->mId
);
1221 if ( !$this->mId
) {
1222 // Anonymous users are not in the database
1223 $this->loadDefaults();
1227 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1228 $db = wfGetDB( $index );
1230 $s = $db->selectRow(
1232 self
::selectFields(),
1233 [ 'user_id' => $this->mId
],
1238 $this->queryFlagsUsed
= $flags;
1239 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1241 if ( $s !== false ) {
1242 // Initialise user table data
1243 $this->loadFromRow( $s );
1244 $this->mGroups
= null; // deferred
1245 $this->getEditCount(); // revalidation for nulls
1250 $this->loadDefaults();
1256 * Initialize this object from a row from the user table.
1258 * @param stdClass $row Row from the user table to load.
1259 * @param array $data Further user data to load into the object
1261 * user_groups Array with groups out of the user_groups table
1262 * user_properties Array with properties out of the user_properties table
1264 protected function loadFromRow( $row, $data = null ) {
1267 $this->mGroups
= null; // deferred
1269 if ( isset( $row->user_name
) ) {
1270 $this->mName
= $row->user_name
;
1271 $this->mFrom
= 'name';
1272 $this->setItemLoaded( 'name' );
1277 if ( isset( $row->user_real_name
) ) {
1278 $this->mRealName
= $row->user_real_name
;
1279 $this->setItemLoaded( 'realname' );
1284 if ( isset( $row->user_id
) ) {
1285 $this->mId
= intval( $row->user_id
);
1286 $this->mFrom
= 'id';
1287 $this->setItemLoaded( 'id' );
1292 if ( isset( $row->user_id
) && isset( $row->user_name
) ) {
1293 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1296 if ( isset( $row->user_editcount
) ) {
1297 $this->mEditCount
= $row->user_editcount
;
1302 if ( isset( $row->user_touched
) ) {
1303 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1308 if ( isset( $row->user_token
) ) {
1309 // The definition for the column is binary(32), so trim the NULs
1310 // that appends. The previous definition was char(32), so trim
1312 $this->mToken
= rtrim( $row->user_token
, " \0" );
1313 if ( $this->mToken
=== '' ) {
1314 $this->mToken
= null;
1320 if ( isset( $row->user_email
) ) {
1321 $this->mEmail
= $row->user_email
;
1322 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1323 $this->mEmailToken
= $row->user_email_token
;
1324 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1325 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1331 $this->mLoadedItems
= true;
1334 if ( is_array( $data ) ) {
1335 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1336 $this->mGroups
= $data['user_groups'];
1338 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1339 $this->loadOptions( $data['user_properties'] );
1345 * Load the data for this user object from another user object.
1349 protected function loadFromUserObject( $user ) {
1351 foreach ( self
::$mCacheVars as $var ) {
1352 $this->$var = $user->$var;
1357 * Load the groups from the database if they aren't already loaded.
1359 private function loadGroups() {
1360 if ( is_null( $this->mGroups
) ) {
1361 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1362 ?
wfGetDB( DB_MASTER
)
1363 : wfGetDB( DB_SLAVE
);
1364 $res = $db->select( 'user_groups',
1366 [ 'ug_user' => $this->mId
],
1368 $this->mGroups
= [];
1369 foreach ( $res as $row ) {
1370 $this->mGroups
[] = $row->ug_group
;
1376 * Add the user to the group if he/she meets given criteria.
1378 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1379 * possible to remove manually via Special:UserRights. In such case it
1380 * will not be re-added automatically. The user will also not lose the
1381 * group if they no longer meet the criteria.
1383 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1385 * @return array Array of groups the user has been promoted to.
1387 * @see $wgAutopromoteOnce
1389 public function addAutopromoteOnceGroups( $event ) {
1390 global $wgAutopromoteOnceLogInRC;
1392 if ( wfReadOnly() ||
!$this->getId() ) {
1396 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1397 if ( !count( $toPromote ) ) {
1401 if ( !$this->checkAndSetTouched() ) {
1402 return []; // raced out (bug T48834)
1405 $oldGroups = $this->getGroups(); // previous groups
1406 foreach ( $toPromote as $group ) {
1407 $this->addGroup( $group );
1409 // update groups in external authentication database
1410 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false ] );
1411 AuthManager
::callLegacyAuthPlugin( 'updateExternalDBGroups', [ $this, $toPromote ] );
1413 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1415 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1416 $logEntry->setPerformer( $this );
1417 $logEntry->setTarget( $this->getUserPage() );
1418 $logEntry->setParameters( [
1419 '4::oldgroups' => $oldGroups,
1420 '5::newgroups' => $newGroups,
1422 $logid = $logEntry->insert();
1423 if ( $wgAutopromoteOnceLogInRC ) {
1424 $logEntry->publish( $logid );
1431 * Builds update conditions. Additional conditions may be added to $conditions to
1432 * protected against race conditions using a compare-and-set (CAS) mechanism
1433 * based on comparing $this->mTouched with the user_touched field.
1435 * @param DatabaseBase $db
1436 * @param array $conditions WHERE conditions for use with DatabaseBase::update
1437 * @return array WHERE conditions for use with DatabaseBase::update
1439 protected function makeUpdateConditions( DatabaseBase
$db, array $conditions ) {
1440 if ( $this->mTouched
) {
1441 // CAS check: only update if the row wasn't changed sicne it was loaded.
1442 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1449 * Bump user_touched if it didn't change since this object was loaded
1451 * On success, the mTouched field is updated.
1452 * The user serialization cache is always cleared.
1454 * @return bool Whether user_touched was actually updated
1457 protected function checkAndSetTouched() {
1460 if ( !$this->mId
) {
1461 return false; // anon
1464 // Get a new user_touched that is higher than the old one
1465 $newTouched = $this->newTouchedTimestamp();
1467 $dbw = wfGetDB( DB_MASTER
);
1468 $dbw->update( 'user',
1469 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1470 $this->makeUpdateConditions( $dbw, [
1471 'user_id' => $this->mId
,
1475 $success = ( $dbw->affectedRows() > 0 );
1478 $this->mTouched
= $newTouched;
1479 $this->clearSharedCache();
1481 // Clears on failure too since that is desired if the cache is stale
1482 $this->clearSharedCache( 'refresh' );
1489 * Clear various cached data stored in this object. The cache of the user table
1490 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1492 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1493 * given source. May be "name", "id", "defaults", "session", or false for no reload.
1495 public function clearInstanceCache( $reloadFrom = false ) {
1496 $this->mNewtalk
= -1;
1497 $this->mDatePreference
= null;
1498 $this->mBlockedby
= -1; # Unset
1499 $this->mHash
= false;
1500 $this->mRights
= null;
1501 $this->mEffectiveGroups
= null;
1502 $this->mImplicitGroups
= null;
1503 $this->mGroups
= null;
1504 $this->mOptions
= null;
1505 $this->mOptionsLoaded
= false;
1506 $this->mEditCount
= null;
1508 if ( $reloadFrom ) {
1509 $this->mLoadedItems
= [];
1510 $this->mFrom
= $reloadFrom;
1515 * Combine the language default options with any site-specific options
1516 * and add the default language variants.
1518 * @return array Array of String options
1520 public static function getDefaultOptions() {
1521 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1523 static $defOpt = null;
1524 static $defOptLang = null;
1526 if ( $defOpt !== null && $defOptLang === $wgContLang->getCode() ) {
1527 // $wgContLang does not change (and should not change) mid-request,
1528 // but the unit tests change it anyway, and expect this method to
1529 // return values relevant to the current $wgContLang.
1533 $defOpt = $wgDefaultUserOptions;
1534 // Default language setting
1535 $defOptLang = $wgContLang->getCode();
1536 $defOpt['language'] = $defOptLang;
1537 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1538 $defOpt[$langCode == $wgContLang->getCode() ?
'variant' : "variant-$langCode"] = $langCode;
1541 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1542 // since extensions may change the set of searchable namespaces depending
1543 // on user groups/permissions.
1544 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1545 $defOpt['searchNs' . $nsnum] = (boolean
)$val;
1547 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1549 Hooks
::run( 'UserGetDefaultOptions', [ &$defOpt ] );
1555 * Get a given default option value.
1557 * @param string $opt Name of option to retrieve
1558 * @return string Default option value
1560 public static function getDefaultOption( $opt ) {
1561 $defOpts = self
::getDefaultOptions();
1562 if ( isset( $defOpts[$opt] ) ) {
1563 return $defOpts[$opt];
1570 * Get blocking information
1571 * @param bool $bFromSlave Whether to check the slave database first.
1572 * To improve performance, non-critical checks are done against slaves.
1573 * Check when actually saving should be done against master.
1575 private function getBlockedStatus( $bFromSlave = true ) {
1576 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff;
1578 if ( -1 != $this->mBlockedby
) {
1582 wfDebug( __METHOD__
. ": checking...\n" );
1584 // Initialize data...
1585 // Otherwise something ends up stomping on $this->mBlockedby when
1586 // things get lazy-loaded later, causing false positive block hits
1587 // due to -1 !== 0. Probably session-related... Nothing should be
1588 // overwriting mBlockedby, surely?
1591 # We only need to worry about passing the IP address to the Block generator if the
1592 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1593 # know which IP address they're actually coming from
1595 if ( !$this->isAllowed( 'ipblock-exempt' ) ) {
1596 // $wgUser->getName() only works after the end of Setup.php. Until
1597 // then, assume it's a logged-out user.
1598 $globalUserName = $wgUser->isSafeToLoad()
1599 ?
$wgUser->getName()
1600 : IP
::sanitizeIP( $wgUser->getRequest()->getIP() );
1601 if ( $this->getName() === $globalUserName ) {
1602 $ip = $this->getRequest()->getIP();
1607 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1610 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1612 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1614 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1615 $block->mReason
= wfMessage( 'proxyblockreason' )->text();
1616 $block->setTarget( $ip );
1617 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1619 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1620 $block->mReason
= wfMessage( 'sorbsreason' )->text();
1621 $block->setTarget( $ip );
1625 // (bug 23343) Apply IP blocks to the contents of XFF headers, if enabled
1626 if ( !$block instanceof Block
1627 && $wgApplyIpBlocksToXff
1629 && !in_array( $ip, $wgProxyWhitelist )
1631 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1632 $xff = array_map( 'trim', explode( ',', $xff ) );
1633 $xff = array_diff( $xff, [ $ip ] );
1634 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1635 $block = Block
::chooseBlock( $xffblocks, $xff );
1636 if ( $block instanceof Block
) {
1637 # Mangle the reason to alert the user that the block
1638 # originated from matching the X-Forwarded-For header.
1639 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->text();
1643 if ( $block instanceof Block
) {
1644 wfDebug( __METHOD__
. ": Found block.\n" );
1645 $this->mBlock
= $block;
1646 $this->mBlockedby
= $block->getByName();
1647 $this->mBlockreason
= $block->mReason
;
1648 $this->mHideName
= $block->mHideName
;
1649 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1651 $this->mBlockedby
= '';
1652 $this->mHideName
= 0;
1653 $this->mAllowUsertalk
= false;
1657 Hooks
::run( 'GetBlockedStatus', [ &$this ] );
1662 * Whether the given IP is in a DNS blacklist.
1664 * @param string $ip IP to check
1665 * @param bool $checkWhitelist Whether to check the whitelist first
1666 * @return bool True if blacklisted.
1668 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1669 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1671 if ( !$wgEnableDnsBlacklist ) {
1675 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1679 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
1683 * Whether the given IP is in a given DNS blacklist.
1685 * @param string $ip IP to check
1686 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1687 * @return bool True if blacklisted.
1689 public function inDnsBlacklist( $ip, $bases ) {
1692 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1693 if ( IP
::isIPv4( $ip ) ) {
1694 // Reverse IP, bug 21255
1695 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1697 foreach ( (array)$bases as $base ) {
1699 // If we have an access key, use that too (ProjectHoneypot, etc.)
1701 if ( is_array( $base ) ) {
1702 if ( count( $base ) >= 2 ) {
1703 // Access key is 1, base URL is 0
1704 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1706 $host = "$ipReversed.{$base[0]}";
1708 $basename = $base[0];
1710 $host = "$ipReversed.$base";
1714 $ipList = gethostbynamel( $host );
1717 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
1721 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
1730 * Check if an IP address is in the local proxy list
1736 public static function isLocallyBlockedProxy( $ip ) {
1737 global $wgProxyList;
1739 if ( !$wgProxyList ) {
1743 if ( !is_array( $wgProxyList ) ) {
1744 // Load from the specified file
1745 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1748 if ( !is_array( $wgProxyList ) ) {
1750 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1752 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1753 // Old-style flipped proxy list
1762 * Is this user subject to rate limiting?
1764 * @return bool True if rate limited
1766 public function isPingLimitable() {
1767 global $wgRateLimitsExcludedIPs;
1768 if ( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1769 // No other good way currently to disable rate limits
1770 // for specific IPs. :P
1771 // But this is a crappy hack and should die.
1774 return !$this->isAllowed( 'noratelimit' );
1778 * Primitive rate limits: enforce maximum actions per time period
1779 * to put a brake on flooding.
1781 * The method generates both a generic profiling point and a per action one
1782 * (suffix being "-$action".
1784 * @note When using a shared cache like memcached, IP-address
1785 * last-hit counters will be shared across wikis.
1787 * @param string $action Action to enforce; 'edit' if unspecified
1788 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1789 * @return bool True if a rate limiter was tripped
1791 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1792 // Call the 'PingLimiter' hook
1794 if ( !Hooks
::run( 'PingLimiter', [ &$this, $action, &$result, $incrBy ] ) ) {
1798 global $wgRateLimits;
1799 if ( !isset( $wgRateLimits[$action] ) ) {
1803 // Some groups shouldn't trigger the ping limiter, ever
1804 if ( !$this->isPingLimitable() ) {
1808 $limits = $wgRateLimits[$action];
1810 $id = $this->getId();
1812 $isNewbie = $this->isNewbie();
1816 if ( isset( $limits['anon'] ) ) {
1817 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1820 // limits for logged-in users
1821 if ( isset( $limits['user'] ) ) {
1822 $userLimit = $limits['user'];
1824 // limits for newbie logged-in users
1825 if ( $isNewbie && isset( $limits['newbie'] ) ) {
1826 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1830 // limits for anons and for newbie logged-in users
1833 if ( isset( $limits['ip'] ) ) {
1834 $ip = $this->getRequest()->getIP();
1835 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1837 // subnet-based limits
1838 if ( isset( $limits['subnet'] ) ) {
1839 $ip = $this->getRequest()->getIP();
1840 $subnet = IP
::getSubnet( $ip );
1841 if ( $subnet !== false ) {
1842 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1847 // Check for group-specific permissions
1848 // If more than one group applies, use the group with the highest limit ratio (max/period)
1849 foreach ( $this->getGroups() as $group ) {
1850 if ( isset( $limits[$group] ) ) {
1851 if ( $userLimit === false
1852 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
1854 $userLimit = $limits[$group];
1859 // Set the user limit key
1860 if ( $userLimit !== false ) {
1861 list( $max, $period ) = $userLimit;
1862 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
1863 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $userLimit;
1866 // ip-based limits for all ping-limitable users
1867 if ( isset( $limits['ip-all'] ) ) {
1868 $ip = $this->getRequest()->getIP();
1869 // ignore if user limit is more permissive
1870 if ( $isNewbie ||
$userLimit === false
1871 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
1872 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
1876 // subnet-based limits for all ping-limitable users
1877 if ( isset( $limits['subnet-all'] ) ) {
1878 $ip = $this->getRequest()->getIP();
1879 $subnet = IP
::getSubnet( $ip );
1880 if ( $subnet !== false ) {
1881 // ignore if user limit is more permissive
1882 if ( $isNewbie ||
$userLimit === false
1883 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
1884 > $userLimit[0] / $userLimit[1] ) {
1885 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
1890 $cache = ObjectCache
::getLocalClusterInstance();
1893 foreach ( $keys as $key => $limit ) {
1894 list( $max, $period ) = $limit;
1895 $summary = "(limit $max in {$period}s)";
1896 $count = $cache->get( $key );
1899 if ( $count >= $max ) {
1900 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
1901 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
1904 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1907 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1908 if ( $incrBy > 0 ) {
1909 $cache->add( $key, 0, intval( $period ) ); // first ping
1912 if ( $incrBy > 0 ) {
1913 $cache->incr( $key, $incrBy );
1921 * Check if user is blocked
1923 * @param bool $bFromSlave Whether to check the slave database instead of
1924 * the master. Hacked from false due to horrible probs on site.
1925 * @return bool True if blocked, false otherwise
1927 public function isBlocked( $bFromSlave = true ) {
1928 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1932 * Get the block affecting the user, or null if the user is not blocked
1934 * @param bool $bFromSlave Whether to check the slave database instead of the master
1935 * @return Block|null
1937 public function getBlock( $bFromSlave = true ) {
1938 $this->getBlockedStatus( $bFromSlave );
1939 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1943 * Check if user is blocked from editing a particular article
1945 * @param Title $title Title to check
1946 * @param bool $bFromSlave Whether to check the slave database instead of the master
1949 public function isBlockedFrom( $title, $bFromSlave = false ) {
1950 global $wgBlockAllowsUTEdit;
1952 $blocked = $this->isBlocked( $bFromSlave );
1953 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1954 // If a user's name is suppressed, they cannot make edits anywhere
1955 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName()
1956 && $title->getNamespace() == NS_USER_TALK
) {
1958 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1961 Hooks
::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
1967 * If user is blocked, return the name of the user who placed the block
1968 * @return string Name of blocker
1970 public function blockedBy() {
1971 $this->getBlockedStatus();
1972 return $this->mBlockedby
;
1976 * If user is blocked, return the specified reason for the block
1977 * @return string Blocking reason
1979 public function blockedFor() {
1980 $this->getBlockedStatus();
1981 return $this->mBlockreason
;
1985 * If user is blocked, return the ID for the block
1986 * @return int Block ID
1988 public function getBlockId() {
1989 $this->getBlockedStatus();
1990 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1994 * Check if user is blocked on all wikis.
1995 * Do not use for actual edit permission checks!
1996 * This is intended for quick UI checks.
1998 * @param string $ip IP address, uses current client if none given
1999 * @return bool True if blocked, false otherwise
2001 public function isBlockedGlobally( $ip = '' ) {
2002 return $this->getGlobalBlock( $ip ) instanceof Block
;
2006 * Check if user is blocked on all wikis.
2007 * Do not use for actual edit permission checks!
2008 * This is intended for quick UI checks.
2010 * @param string $ip IP address, uses current client if none given
2011 * @return Block|null Block object if blocked, null otherwise
2012 * @throws FatalError
2013 * @throws MWException
2015 public function getGlobalBlock( $ip = '' ) {
2016 if ( $this->mGlobalBlock
!== null ) {
2017 return $this->mGlobalBlock ?
: null;
2019 // User is already an IP?
2020 if ( IP
::isIPAddress( $this->getName() ) ) {
2021 $ip = $this->getName();
2023 $ip = $this->getRequest()->getIP();
2027 Hooks
::run( 'UserIsBlockedGlobally', [ &$this, $ip, &$blocked, &$block ] );
2029 if ( $blocked && $block === null ) {
2030 // back-compat: UserIsBlockedGlobally didn't have $block param first
2032 $block->setTarget( $ip );
2035 $this->mGlobalBlock
= $blocked ?
$block : false;
2036 return $this->mGlobalBlock ?
: null;
2040 * Check if user account is locked
2042 * @return bool True if locked, false otherwise
2044 public function isLocked() {
2045 if ( $this->mLocked
!== null ) {
2046 return $this->mLocked
;
2048 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$this ], null );
2049 $this->mLocked
= $authUser && $authUser->isLocked();
2050 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2051 return $this->mLocked
;
2055 * Check if user account is hidden
2057 * @return bool True if hidden, false otherwise
2059 public function isHidden() {
2060 if ( $this->mHideName
!== null ) {
2061 return $this->mHideName
;
2063 $this->getBlockedStatus();
2064 if ( !$this->mHideName
) {
2065 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$this ], null );
2066 $this->mHideName
= $authUser && $authUser->isHidden();
2067 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2069 return $this->mHideName
;
2073 * Get the user's ID.
2074 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2076 public function getId() {
2077 if ( $this->mId
=== null && $this->mName
!== null && User
::isIP( $this->mName
) ) {
2078 // Special case, we know the user is anonymous
2080 } elseif ( !$this->isItemLoaded( 'id' ) ) {
2081 // Don't load if this was initialized from an ID
2085 return (int)$this->mId
;
2089 * Set the user and reload all fields according to a given ID
2090 * @param int $v User ID to reload
2092 public function setId( $v ) {
2094 $this->clearInstanceCache( 'id' );
2098 * Get the user name, or the IP of an anonymous user
2099 * @return string User's name or IP address
2101 public function getName() {
2102 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2103 // Special case optimisation
2104 return $this->mName
;
2107 if ( $this->mName
=== false ) {
2109 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2111 return $this->mName
;
2116 * Set the user name.
2118 * This does not reload fields from the database according to the given
2119 * name. Rather, it is used to create a temporary "nonexistent user" for
2120 * later addition to the database. It can also be used to set the IP
2121 * address for an anonymous user to something other than the current
2124 * @note User::newFromName() has roughly the same function, when the named user
2126 * @param string $str New user name to set
2128 public function setName( $str ) {
2130 $this->mName
= $str;
2134 * Get the user's name escaped by underscores.
2135 * @return string Username escaped by underscores.
2137 public function getTitleKey() {
2138 return str_replace( ' ', '_', $this->getName() );
2142 * Check if the user has new messages.
2143 * @return bool True if the user has new messages
2145 public function getNewtalk() {
2148 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2149 if ( $this->mNewtalk
=== -1 ) {
2150 $this->mNewtalk
= false; # reset talk page status
2152 // Check memcached separately for anons, who have no
2153 // entire User object stored in there.
2154 if ( !$this->mId
) {
2155 global $wgDisableAnonTalk;
2156 if ( $wgDisableAnonTalk ) {
2157 // Anon newtalk disabled by configuration.
2158 $this->mNewtalk
= false;
2160 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2163 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2167 return (bool)$this->mNewtalk
;
2171 * Return the data needed to construct links for new talk page message
2172 * alerts. If there are new messages, this will return an associative array
2173 * with the following data:
2174 * wiki: The database name of the wiki
2175 * link: Root-relative link to the user's talk page
2176 * rev: The last talk page revision that the user has seen or null. This
2177 * is useful for building diff links.
2178 * If there are no new messages, it returns an empty array.
2179 * @note This function was designed to accomodate multiple talk pages, but
2180 * currently only returns a single link and revision.
2183 public function getNewMessageLinks() {
2185 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$this, &$talks ] ) ) {
2187 } elseif ( !$this->getNewtalk() ) {
2190 $utp = $this->getTalkPage();
2191 $dbr = wfGetDB( DB_SLAVE
);
2192 // Get the "last viewed rev" timestamp from the oldest message notification
2193 $timestamp = $dbr->selectField( 'user_newtalk',
2194 'MIN(user_last_timestamp)',
2195 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2197 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2198 return [ [ 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ] ];
2202 * Get the revision ID for the last talk page revision viewed by the talk
2204 * @return int|null Revision ID or null
2206 public function getNewMessageRevisionId() {
2207 $newMessageRevisionId = null;
2208 $newMessageLinks = $this->getNewMessageLinks();
2209 if ( $newMessageLinks ) {
2210 // Note: getNewMessageLinks() never returns more than a single link
2211 // and it is always for the same wiki, but we double-check here in
2212 // case that changes some time in the future.
2213 if ( count( $newMessageLinks ) === 1
2214 && $newMessageLinks[0]['wiki'] === wfWikiID()
2215 && $newMessageLinks[0]['rev']
2217 /** @var Revision $newMessageRevision */
2218 $newMessageRevision = $newMessageLinks[0]['rev'];
2219 $newMessageRevisionId = $newMessageRevision->getId();
2222 return $newMessageRevisionId;
2226 * Internal uncached check for new messages
2229 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2230 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2231 * @return bool True if the user has new messages
2233 protected function checkNewtalk( $field, $id ) {
2234 $dbr = wfGetDB( DB_SLAVE
);
2236 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2238 return $ok !== false;
2242 * Add or update the new messages flag
2243 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2244 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2245 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2246 * @return bool True if successful, false otherwise
2248 protected function updateNewtalk( $field, $id, $curRev = null ) {
2249 // Get timestamp of the talk page revision prior to the current one
2250 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2251 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2252 // Mark the user as having new messages since this revision
2253 $dbw = wfGetDB( DB_MASTER
);
2254 $dbw->insert( 'user_newtalk',
2255 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2258 if ( $dbw->affectedRows() ) {
2259 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2262 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2268 * Clear the new messages flag for the given user
2269 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2270 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2271 * @return bool True if successful, false otherwise
2273 protected function deleteNewtalk( $field, $id ) {
2274 $dbw = wfGetDB( DB_MASTER
);
2275 $dbw->delete( 'user_newtalk',
2278 if ( $dbw->affectedRows() ) {
2279 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2282 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2288 * Update the 'You have new messages!' status.
2289 * @param bool $val Whether the user has new messages
2290 * @param Revision $curRev New, as yet unseen revision of the user talk
2291 * page. Ignored if null or !$val.
2293 public function setNewtalk( $val, $curRev = null ) {
2294 if ( wfReadOnly() ) {
2299 $this->mNewtalk
= $val;
2301 if ( $this->isAnon() ) {
2303 $id = $this->getName();
2306 $id = $this->getId();
2310 $changed = $this->updateNewtalk( $field, $id, $curRev );
2312 $changed = $this->deleteNewtalk( $field, $id );
2316 $this->invalidateCache();
2321 * Generate a current or new-future timestamp to be stored in the
2322 * user_touched field when we update things.
2323 * @return string Timestamp in TS_MW format
2325 private function newTouchedTimestamp() {
2326 global $wgClockSkewFudge;
2328 $time = wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2329 if ( $this->mTouched
&& $time <= $this->mTouched
) {
2330 $time = wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2337 * Clear user data from memcached
2339 * Use after applying updates to the database; caller's
2340 * responsibility to update user_touched if appropriate.
2342 * Called implicitly from invalidateCache() and saveSettings().
2344 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2346 public function clearSharedCache( $mode = 'changed' ) {
2347 if ( !$this->getId() ) {
2351 $cache = ObjectCache
::getMainWANInstance();
2352 $key = $this->getCacheKey( $cache );
2353 if ( $mode === 'refresh' ) {
2354 $cache->delete( $key, 1 );
2356 wfGetDB( DB_MASTER
)->onTransactionPreCommitOrIdle(
2357 function() use ( $cache, $key ) {
2358 $cache->delete( $key );
2365 * Immediately touch the user data cache for this account
2367 * Calls touch() and removes account data from memcached
2369 public function invalidateCache() {
2371 $this->clearSharedCache();
2375 * Update the "touched" timestamp for the user
2377 * This is useful on various login/logout events when making sure that
2378 * a browser or proxy that has multiple tenants does not suffer cache
2379 * pollution where the new user sees the old users content. The value
2380 * of getTouched() is checked when determining 304 vs 200 responses.
2381 * Unlike invalidateCache(), this preserves the User object cache and
2382 * avoids database writes.
2386 public function touch() {
2387 $id = $this->getId();
2389 $key = wfMemcKey( 'user-quicktouched', 'id', $id );
2390 ObjectCache
::getMainWANInstance()->touchCheckKey( $key );
2391 $this->mQuickTouched
= null;
2396 * Validate the cache for this account.
2397 * @param string $timestamp A timestamp in TS_MW format
2400 public function validateCache( $timestamp ) {
2401 return ( $timestamp >= $this->getTouched() );
2405 * Get the user touched timestamp
2407 * Use this value only to validate caches via inequalities
2408 * such as in the case of HTTP If-Modified-Since response logic
2410 * @return string TS_MW Timestamp
2412 public function getTouched() {
2416 if ( $this->mQuickTouched
=== null ) {
2417 $key = wfMemcKey( 'user-quicktouched', 'id', $this->mId
);
2418 $cache = ObjectCache
::getMainWANInstance();
2420 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2423 return max( $this->mTouched
, $this->mQuickTouched
);
2426 return $this->mTouched
;
2430 * Get the user_touched timestamp field (time of last DB updates)
2431 * @return string TS_MW Timestamp
2434 public function getDBTouched() {
2437 return $this->mTouched
;
2441 * @deprecated Removed in 1.27.
2445 public function getPassword() {
2446 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2450 * @deprecated Removed in 1.27.
2454 public function getTemporaryPassword() {
2455 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2459 * Set the password and reset the random token.
2460 * Calls through to authentication plugin if necessary;
2461 * will have no effect if the auth plugin refuses to
2462 * pass the change through or if the legal password
2465 * As a special case, setting the password to null
2466 * wipes it, so the account cannot be logged in until
2467 * a new password is set, for instance via e-mail.
2469 * @deprecated since 1.27, use AuthManager instead
2470 * @param string $str New password to set
2471 * @throws PasswordError On failure
2474 public function setPassword( $str ) {
2475 return $this->setPasswordInternal( $str );
2479 * Set the password and reset the random token unconditionally.
2481 * @deprecated since 1.27, use AuthManager instead
2482 * @param string|null $str New password to set or null to set an invalid
2483 * password hash meaning that the user will not be able to log in
2484 * through the web interface.
2486 public function setInternalPassword( $str ) {
2487 $this->setPasswordInternal( $str );
2491 * Actually set the password and such
2492 * @since 1.27 cannot set a password for a user not in the database
2493 * @param string|null $str New password to set or null to set an invalid
2494 * password hash meaning that the user will not be able to log in
2495 * through the web interface.
2496 * @return bool Success
2498 private function setPasswordInternal( $str ) {
2499 $manager = AuthManager
::singleton();
2501 // If the user doesn't exist yet, fail
2502 if ( !$manager->userExists( $this->getName() ) ) {
2503 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2506 $status = $this->changeAuthenticationData( [
2507 'username' => $this->getName(),
2511 if ( !$status->isGood() ) {
2512 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2513 ->info( __METHOD__
. ': Password change rejected: '
2514 . $status->getWikiText( null, null, 'en' ) );
2518 $this->setOption( 'watchlisttoken', false );
2519 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2525 * Changes credentials of the user.
2527 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2528 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2529 * e.g. when no provider handled the change.
2531 * @param array $data A set of authentication data in fieldname => value format. This is the
2532 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2536 public function changeAuthenticationData( array $data ) {
2537 $manager = AuthManager
::singleton();
2538 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2539 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2541 $status = Status
::newGood( 'ignored' );
2542 foreach ( $reqs as $req ) {
2543 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2545 if ( $status->getValue() === 'ignored' ) {
2546 $status->warning( 'authenticationdatachange-ignored' );
2549 if ( $status->isGood() ) {
2550 foreach ( $reqs as $req ) {
2551 $manager->changeAuthenticationData( $req );
2558 * Get the user's current token.
2559 * @param bool $forceCreation Force the generation of a new token if the
2560 * user doesn't have one (default=true for backwards compatibility).
2561 * @return string|null Token
2563 public function getToken( $forceCreation = true ) {
2564 global $wgAuthenticationTokenVersion;
2567 if ( !$this->mToken
&& $forceCreation ) {
2571 if ( !$this->mToken
) {
2572 // The user doesn't have a token, return null to indicate that.
2574 } elseif ( $this->mToken
=== self
::INVALID_TOKEN
) {
2575 // We return a random value here so existing token checks are very
2577 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2578 } elseif ( $wgAuthenticationTokenVersion === null ) {
2579 // $wgAuthenticationTokenVersion not in use, so return the raw secret
2580 return $this->mToken
;
2582 // $wgAuthenticationTokenVersion in use, so hmac it.
2583 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
2585 // The raw hash can be overly long. Shorten it up.
2586 $len = max( 32, self
::TOKEN_LENGTH
);
2587 if ( strlen( $ret ) < $len ) {
2588 // Should never happen, even md5 is 128 bits
2589 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
2591 return substr( $ret, -$len );
2596 * Set the random token (used for persistent authentication)
2597 * Called from loadDefaults() among other places.
2599 * @param string|bool $token If specified, set the token to this value
2601 public function setToken( $token = false ) {
2603 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
2604 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
2605 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
2606 } elseif ( !$token ) {
2607 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2609 $this->mToken
= $token;
2614 * Set the password for a password reminder or new account email
2616 * @deprecated Removed in 1.27. Use PasswordReset instead.
2617 * @param string $str New password to set or null to set an invalid
2618 * password hash meaning that the user will not be able to use it
2619 * @param bool $throttle If true, reset the throttle timestamp to the present
2621 public function setNewpassword( $str, $throttle = true ) {
2622 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2626 * Has password reminder email been sent within the last
2627 * $wgPasswordReminderResendTime hours?
2628 * @deprecated Removed in 1.27. See above.
2631 public function isPasswordReminderThrottled() {
2632 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2636 * Get the user's e-mail address
2637 * @return string User's email address
2639 public function getEmail() {
2641 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
2642 return $this->mEmail
;
2646 * Get the timestamp of the user's e-mail authentication
2647 * @return string TS_MW timestamp
2649 public function getEmailAuthenticationTimestamp() {
2651 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
2652 return $this->mEmailAuthenticated
;
2656 * Set the user's e-mail address
2657 * @param string $str New e-mail address
2659 public function setEmail( $str ) {
2661 if ( $str == $this->mEmail
) {
2664 $this->invalidateEmail();
2665 $this->mEmail
= $str;
2666 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
2670 * Set the user's e-mail address and a confirmation mail if needed.
2673 * @param string $str New e-mail address
2676 public function setEmailWithConfirmation( $str ) {
2677 global $wgEnableEmail, $wgEmailAuthentication;
2679 if ( !$wgEnableEmail ) {
2680 return Status
::newFatal( 'emaildisabled' );
2683 $oldaddr = $this->getEmail();
2684 if ( $str === $oldaddr ) {
2685 return Status
::newGood( true );
2688 $type = $oldaddr != '' ?
'changed' : 'set';
2689 $notificationResult = null;
2691 if ( $wgEmailAuthentication ) {
2692 // Send the user an email notifying the user of the change in registered
2693 // email address on their previous email address
2694 if ( $type == 'changed' ) {
2695 $change = $str != '' ?
'changed' : 'removed';
2696 $notificationResult = $this->sendMail(
2697 wfMessage( 'notificationemail_subject_' . $change )->text(),
2698 wfMessage( 'notificationemail_body_' . $change,
2699 $this->getRequest()->getIP(),
2706 $this->setEmail( $str );
2708 if ( $str !== '' && $wgEmailAuthentication ) {
2709 // Send a confirmation request to the new address if needed
2710 $result = $this->sendConfirmationMail( $type );
2712 if ( $notificationResult !== null ) {
2713 $result->merge( $notificationResult );
2716 if ( $result->isGood() ) {
2717 // Say to the caller that a confirmation and notification mail has been sent
2718 $result->value
= 'eauth';
2721 $result = Status
::newGood( true );
2728 * Get the user's real name
2729 * @return string User's real name
2731 public function getRealName() {
2732 if ( !$this->isItemLoaded( 'realname' ) ) {
2736 return $this->mRealName
;
2740 * Set the user's real name
2741 * @param string $str New real name
2743 public function setRealName( $str ) {
2745 $this->mRealName
= $str;
2749 * Get the user's current setting for a given option.
2751 * @param string $oname The option to check
2752 * @param string $defaultOverride A default value returned if the option does not exist
2753 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2754 * @return string User's current value for the option
2755 * @see getBoolOption()
2756 * @see getIntOption()
2758 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2759 global $wgHiddenPrefs;
2760 $this->loadOptions();
2762 # We want 'disabled' preferences to always behave as the default value for
2763 # users, even if they have set the option explicitly in their settings (ie they
2764 # set it, and then it was disabled removing their ability to change it). But
2765 # we don't want to erase the preferences in the database in case the preference
2766 # is re-enabled again. So don't touch $mOptions, just override the returned value
2767 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2768 return self
::getDefaultOption( $oname );
2771 if ( array_key_exists( $oname, $this->mOptions
) ) {
2772 return $this->mOptions
[$oname];
2774 return $defaultOverride;
2779 * Get all user's options
2781 * @param int $flags Bitwise combination of:
2782 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
2783 * to the default value. (Since 1.25)
2786 public function getOptions( $flags = 0 ) {
2787 global $wgHiddenPrefs;
2788 $this->loadOptions();
2789 $options = $this->mOptions
;
2791 # We want 'disabled' preferences to always behave as the default value for
2792 # users, even if they have set the option explicitly in their settings (ie they
2793 # set it, and then it was disabled removing their ability to change it). But
2794 # we don't want to erase the preferences in the database in case the preference
2795 # is re-enabled again. So don't touch $mOptions, just override the returned value
2796 foreach ( $wgHiddenPrefs as $pref ) {
2797 $default = self
::getDefaultOption( $pref );
2798 if ( $default !== null ) {
2799 $options[$pref] = $default;
2803 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
2804 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
2811 * Get the user's current setting for a given option, as a boolean value.
2813 * @param string $oname The option to check
2814 * @return bool User's current value for the option
2817 public function getBoolOption( $oname ) {
2818 return (bool)$this->getOption( $oname );
2822 * Get the user's current setting for a given option, as an integer value.
2824 * @param string $oname The option to check
2825 * @param int $defaultOverride A default value returned if the option does not exist
2826 * @return int User's current value for the option
2829 public function getIntOption( $oname, $defaultOverride = 0 ) {
2830 $val = $this->getOption( $oname );
2832 $val = $defaultOverride;
2834 return intval( $val );
2838 * Set the given option for a user.
2840 * You need to call saveSettings() to actually write to the database.
2842 * @param string $oname The option to set
2843 * @param mixed $val New value to set
2845 public function setOption( $oname, $val ) {
2846 $this->loadOptions();
2848 // Explicitly NULL values should refer to defaults
2849 if ( is_null( $val ) ) {
2850 $val = self
::getDefaultOption( $oname );
2853 $this->mOptions
[$oname] = $val;
2857 * Get a token stored in the preferences (like the watchlist one),
2858 * resetting it if it's empty (and saving changes).
2860 * @param string $oname The option name to retrieve the token from
2861 * @return string|bool User's current value for the option, or false if this option is disabled.
2862 * @see resetTokenFromOption()
2864 * @deprecated since 1.26 Applications should use the OAuth extension
2866 public function getTokenFromOption( $oname ) {
2867 global $wgHiddenPrefs;
2869 $id = $this->getId();
2870 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
2874 $token = $this->getOption( $oname );
2876 // Default to a value based on the user token to avoid space
2877 // wasted on storing tokens for all users. When this option
2878 // is set manually by the user, only then is it stored.
2879 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
2886 * Reset a token stored in the preferences (like the watchlist one).
2887 * *Does not* save user's preferences (similarly to setOption()).
2889 * @param string $oname The option name to reset the token in
2890 * @return string|bool New token value, or false if this option is disabled.
2891 * @see getTokenFromOption()
2894 public function resetTokenFromOption( $oname ) {
2895 global $wgHiddenPrefs;
2896 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2900 $token = MWCryptRand
::generateHex( 40 );
2901 $this->setOption( $oname, $token );
2906 * Return a list of the types of user options currently returned by
2907 * User::getOptionKinds().
2909 * Currently, the option kinds are:
2910 * - 'registered' - preferences which are registered in core MediaWiki or
2911 * by extensions using the UserGetDefaultOptions hook.
2912 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2913 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
2914 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2915 * be used by user scripts.
2916 * - 'special' - "preferences" that are not accessible via User::getOptions
2917 * or User::setOptions.
2918 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2919 * These are usually legacy options, removed in newer versions.
2921 * The API (and possibly others) use this function to determine the possible
2922 * option types for validation purposes, so make sure to update this when a
2923 * new option kind is added.
2925 * @see User::getOptionKinds
2926 * @return array Option kinds
2928 public static function listOptionKinds() {
2931 'registered-multiselect',
2932 'registered-checkmatrix',
2940 * Return an associative array mapping preferences keys to the kind of a preference they're
2941 * used for. Different kinds are handled differently when setting or reading preferences.
2943 * See User::listOptionKinds for the list of valid option types that can be provided.
2945 * @see User::listOptionKinds
2946 * @param IContextSource $context
2947 * @param array $options Assoc. array with options keys to check as keys.
2948 * Defaults to $this->mOptions.
2949 * @return array The key => kind mapping data
2951 public function getOptionKinds( IContextSource
$context, $options = null ) {
2952 $this->loadOptions();
2953 if ( $options === null ) {
2954 $options = $this->mOptions
;
2957 $prefs = Preferences
::getPreferences( $this, $context );
2960 // Pull out the "special" options, so they don't get converted as
2961 // multiselect or checkmatrix.
2962 $specialOptions = array_fill_keys( Preferences
::getSaveBlacklist(), true );
2963 foreach ( $specialOptions as $name => $value ) {
2964 unset( $prefs[$name] );
2967 // Multiselect and checkmatrix options are stored in the database with
2968 // one key per option, each having a boolean value. Extract those keys.
2969 $multiselectOptions = [];
2970 foreach ( $prefs as $name => $info ) {
2971 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
2972 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
2973 $opts = HTMLFormField
::flattenOptions( $info['options'] );
2974 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2976 foreach ( $opts as $value ) {
2977 $multiselectOptions["$prefix$value"] = true;
2980 unset( $prefs[$name] );
2983 $checkmatrixOptions = [];
2984 foreach ( $prefs as $name => $info ) {
2985 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
2986 ( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
2987 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
2988 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
2989 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2991 foreach ( $columns as $column ) {
2992 foreach ( $rows as $row ) {
2993 $checkmatrixOptions["$prefix$column-$row"] = true;
2997 unset( $prefs[$name] );
3001 // $value is ignored
3002 foreach ( $options as $key => $value ) {
3003 if ( isset( $prefs[$key] ) ) {
3004 $mapping[$key] = 'registered';
3005 } elseif ( isset( $multiselectOptions[$key] ) ) {
3006 $mapping[$key] = 'registered-multiselect';
3007 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3008 $mapping[$key] = 'registered-checkmatrix';
3009 } elseif ( isset( $specialOptions[$key] ) ) {
3010 $mapping[$key] = 'special';
3011 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3012 $mapping[$key] = 'userjs';
3014 $mapping[$key] = 'unused';
3022 * Reset certain (or all) options to the site defaults
3024 * The optional parameter determines which kinds of preferences will be reset.
3025 * Supported values are everything that can be reported by getOptionKinds()
3026 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3028 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3029 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3030 * for backwards-compatibility.
3031 * @param IContextSource|null $context Context source used when $resetKinds
3032 * does not contain 'all', passed to getOptionKinds().
3033 * Defaults to RequestContext::getMain() when null.
3035 public function resetOptions(
3036 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3037 IContextSource
$context = null
3040 $defaultOptions = self
::getDefaultOptions();
3042 if ( !is_array( $resetKinds ) ) {
3043 $resetKinds = [ $resetKinds ];
3046 if ( in_array( 'all', $resetKinds ) ) {
3047 $newOptions = $defaultOptions;
3049 if ( $context === null ) {
3050 $context = RequestContext
::getMain();
3053 $optionKinds = $this->getOptionKinds( $context );
3054 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3057 // Use default values for the options that should be deleted, and
3058 // copy old values for the ones that shouldn't.
3059 foreach ( $this->mOptions
as $key => $value ) {
3060 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3061 if ( array_key_exists( $key, $defaultOptions ) ) {
3062 $newOptions[$key] = $defaultOptions[$key];
3065 $newOptions[$key] = $value;
3070 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3072 $this->mOptions
= $newOptions;
3073 $this->mOptionsLoaded
= true;
3077 * Get the user's preferred date format.
3078 * @return string User's preferred date format
3080 public function getDatePreference() {
3081 // Important migration for old data rows
3082 if ( is_null( $this->mDatePreference
) ) {
3084 $value = $this->getOption( 'date' );
3085 $map = $wgLang->getDatePreferenceMigrationMap();
3086 if ( isset( $map[$value] ) ) {
3087 $value = $map[$value];
3089 $this->mDatePreference
= $value;
3091 return $this->mDatePreference
;
3095 * Determine based on the wiki configuration and the user's options,
3096 * whether this user must be over HTTPS no matter what.
3100 public function requiresHTTPS() {
3101 global $wgSecureLogin;
3102 if ( !$wgSecureLogin ) {
3105 $https = $this->getBoolOption( 'prefershttps' );
3106 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3108 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3115 * Get the user preferred stub threshold
3119 public function getStubThreshold() {
3120 global $wgMaxArticleSize; # Maximum article size, in Kb
3121 $threshold = $this->getIntOption( 'stubthreshold' );
3122 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3123 // If they have set an impossible value, disable the preference
3124 // so we can use the parser cache again.
3131 * Get the permissions this user has.
3132 * @return array Array of String permission names
3134 public function getRights() {
3135 if ( is_null( $this->mRights
) ) {
3136 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3138 // Deny any rights denied by the user's session, unless this
3139 // endpoint has no sessions.
3140 if ( !defined( 'MW_NO_SESSION' ) ) {
3141 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3142 if ( $allowedRights !== null ) {
3143 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3147 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3148 // Force reindexation of rights when a hook has unset one of them
3149 $this->mRights
= array_values( array_unique( $this->mRights
) );
3151 return $this->mRights
;
3155 * Get the list of explicit group memberships this user has.
3156 * The implicit * and user groups are not included.
3157 * @return array Array of String internal group names
3159 public function getGroups() {
3161 $this->loadGroups();
3162 return $this->mGroups
;
3166 * Get the list of implicit group memberships this user has.
3167 * This includes all explicit groups, plus 'user' if logged in,
3168 * '*' for all accounts, and autopromoted groups
3169 * @param bool $recache Whether to avoid the cache
3170 * @return array Array of String internal group names
3172 public function getEffectiveGroups( $recache = false ) {
3173 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3174 $this->mEffectiveGroups
= array_unique( array_merge(
3175 $this->getGroups(), // explicit groups
3176 $this->getAutomaticGroups( $recache ) // implicit groups
3178 // Hook for additional groups
3179 Hooks
::run( 'UserEffectiveGroups', [ &$this, &$this->mEffectiveGroups
] );
3180 // Force reindexation of groups when a hook has unset one of them
3181 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3183 return $this->mEffectiveGroups
;
3187 * Get the list of implicit group memberships this user has.
3188 * This includes 'user' if logged in, '*' for all accounts,
3189 * and autopromoted groups
3190 * @param bool $recache Whether to avoid the cache
3191 * @return array Array of String internal group names
3193 public function getAutomaticGroups( $recache = false ) {
3194 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3195 $this->mImplicitGroups
= [ '*' ];
3196 if ( $this->getId() ) {
3197 $this->mImplicitGroups
[] = 'user';
3199 $this->mImplicitGroups
= array_unique( array_merge(
3200 $this->mImplicitGroups
,
3201 Autopromote
::getAutopromoteGroups( $this )
3205 // Assure data consistency with rights/groups,
3206 // as getEffectiveGroups() depends on this function
3207 $this->mEffectiveGroups
= null;
3210 return $this->mImplicitGroups
;
3214 * Returns the groups the user has belonged to.
3216 * The user may still belong to the returned groups. Compare with getGroups().
3218 * The function will not return groups the user had belonged to before MW 1.17
3220 * @return array Names of the groups the user has belonged to.
3222 public function getFormerGroups() {
3225 if ( is_null( $this->mFormerGroups
) ) {
3226 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3227 ?
wfGetDB( DB_MASTER
)
3228 : wfGetDB( DB_SLAVE
);
3229 $res = $db->select( 'user_former_groups',
3231 [ 'ufg_user' => $this->mId
],
3233 $this->mFormerGroups
= [];
3234 foreach ( $res as $row ) {
3235 $this->mFormerGroups
[] = $row->ufg_group
;
3239 return $this->mFormerGroups
;
3243 * Get the user's edit count.
3244 * @return int|null Null for anonymous users
3246 public function getEditCount() {
3247 if ( !$this->getId() ) {
3251 if ( $this->mEditCount
=== null ) {
3252 /* Populate the count, if it has not been populated yet */
3253 $dbr = wfGetDB( DB_SLAVE
);
3254 // check if the user_editcount field has been initialized
3255 $count = $dbr->selectField(
3256 'user', 'user_editcount',
3257 [ 'user_id' => $this->mId
],
3261 if ( $count === null ) {
3262 // it has not been initialized. do so.
3263 $count = $this->initEditCount();
3265 $this->mEditCount
= $count;
3267 return (int)$this->mEditCount
;
3271 * Add the user to the given group.
3272 * This takes immediate effect.
3273 * @param string $group Name of the group to add
3276 public function addGroup( $group ) {
3279 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group ] ) ) {
3283 $dbw = wfGetDB( DB_MASTER
);
3284 if ( $this->getId() ) {
3285 $dbw->insert( 'user_groups',
3287 'ug_user' => $this->getId(),
3288 'ug_group' => $group,
3294 $this->loadGroups();
3295 $this->mGroups
[] = $group;
3296 // In case loadGroups was not called before, we now have the right twice.
3297 // Get rid of the duplicate.
3298 $this->mGroups
= array_unique( $this->mGroups
);
3300 // Refresh the groups caches, and clear the rights cache so it will be
3301 // refreshed on the next call to $this->getRights().
3302 $this->getEffectiveGroups( true );
3303 $this->mRights
= null;
3305 $this->invalidateCache();
3311 * Remove the user from the given group.
3312 * This takes immediate effect.
3313 * @param string $group Name of the group to remove
3316 public function removeGroup( $group ) {
3318 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3322 $dbw = wfGetDB( DB_MASTER
);
3323 $dbw->delete( 'user_groups',
3325 'ug_user' => $this->getId(),
3326 'ug_group' => $group,
3329 // Remember that the user was in this group
3330 $dbw->insert( 'user_former_groups',
3332 'ufg_user' => $this->getId(),
3333 'ufg_group' => $group,
3339 $this->loadGroups();
3340 $this->mGroups
= array_diff( $this->mGroups
, [ $group ] );
3342 // Refresh the groups caches, and clear the rights cache so it will be
3343 // refreshed on the next call to $this->getRights().
3344 $this->getEffectiveGroups( true );
3345 $this->mRights
= null;
3347 $this->invalidateCache();
3353 * Get whether the user is logged in
3356 public function isLoggedIn() {
3357 return $this->getId() != 0;
3361 * Get whether the user is anonymous
3364 public function isAnon() {
3365 return !$this->isLoggedIn();
3369 * @return bool Whether this user is flagged as being a bot role account
3372 public function isBot() {
3373 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3378 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3384 * Check if user is allowed to access a feature / make an action
3386 * @param string ... Permissions to test
3387 * @return bool True if user is allowed to perform *any* of the given actions
3389 public function isAllowedAny() {
3390 $permissions = func_get_args();
3391 foreach ( $permissions as $permission ) {
3392 if ( $this->isAllowed( $permission ) ) {
3401 * @param string ... Permissions to test
3402 * @return bool True if the user is allowed to perform *all* of the given actions
3404 public function isAllowedAll() {
3405 $permissions = func_get_args();
3406 foreach ( $permissions as $permission ) {
3407 if ( !$this->isAllowed( $permission ) ) {
3415 * Internal mechanics of testing a permission
3416 * @param string $action
3419 public function isAllowed( $action = '' ) {
3420 if ( $action === '' ) {
3421 return true; // In the spirit of DWIM
3423 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3424 // by misconfiguration: 0 == 'foo'
3425 return in_array( $action, $this->getRights(), true );
3429 * Check whether to enable recent changes patrol features for this user
3430 * @return bool True or false
3432 public function useRCPatrol() {
3433 global $wgUseRCPatrol;
3434 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3438 * Check whether to enable new pages patrol features for this user
3439 * @return bool True or false
3441 public function useNPPatrol() {
3442 global $wgUseRCPatrol, $wgUseNPPatrol;
3444 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3445 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3450 * Check whether to enable new files patrol features for this user
3451 * @return bool True or false
3453 public function useFilePatrol() {
3454 global $wgUseRCPatrol, $wgUseFilePatrol;
3456 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3457 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3462 * Get the WebRequest object to use with this object
3464 * @return WebRequest
3466 public function getRequest() {
3467 if ( $this->mRequest
) {
3468 return $this->mRequest
;
3476 * Check the watched status of an article.
3477 * @since 1.22 $checkRights parameter added
3478 * @param Title $title Title of the article to look at
3479 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3480 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3483 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3484 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3485 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3492 * @since 1.22 $checkRights parameter added
3493 * @param Title $title Title of the article to look at
3494 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3495 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3497 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3498 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3499 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3501 [ $title->getSubjectPage(), $title->getTalkPage() ]
3504 $this->invalidateCache();
3508 * Stop watching an article.
3509 * @since 1.22 $checkRights parameter added
3510 * @param Title $title Title of the article to look at
3511 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3512 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3514 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3515 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3516 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3517 $store->removeWatch( $this, $title->getSubjectPage() );
3518 $store->removeWatch( $this, $title->getTalkPage() );
3520 $this->invalidateCache();
3524 * Clear the user's notification timestamp for the given title.
3525 * If e-notif e-mails are on, they will receive notification mails on
3526 * the next change of the page if it's watched etc.
3527 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3528 * @param Title $title Title of the article to look at
3529 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3531 public function clearNotification( &$title, $oldid = 0 ) {
3532 global $wgUseEnotif, $wgShowUpdatedMarker;
3534 // Do nothing if the database is locked to writes
3535 if ( wfReadOnly() ) {
3539 // Do nothing if not allowed to edit the watchlist
3540 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3544 // If we're working on user's talk page, we should update the talk page message indicator
3545 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3546 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$this, $oldid ] ) ) {
3550 // Try to update the DB post-send and only if needed...
3551 DeferredUpdates
::addCallableUpdate( function() use ( $title, $oldid ) {
3552 if ( !$this->getNewtalk() ) {
3553 return; // no notifications to clear
3556 // Delete the last notifications (they stack up)
3557 $this->setNewtalk( false );
3559 // If there is a new, unseen, revision, use its timestamp
3561 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
3564 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
3569 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3573 if ( $this->isAnon() ) {
3574 // Nothing else to do...
3578 // Only update the timestamp if the page is being watched.
3579 // The query to find out if it is watched is cached both in memcached and per-invocation,
3580 // and when it does have to be executed, it can be on a slave
3581 // If this is the user's newtalk page, we always update the timestamp
3583 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3587 MediaWikiServices
::getInstance()->getWatchedItemStore()
3588 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
3592 * Resets all of the given user's page-change notification timestamps.
3593 * If e-notif e-mails are on, they will receive notification mails on
3594 * the next change of any watched page.
3595 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3597 public function clearAllNotifications() {
3598 if ( wfReadOnly() ) {
3602 // Do nothing if not allowed to edit the watchlist
3603 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3607 global $wgUseEnotif, $wgShowUpdatedMarker;
3608 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3609 $this->setNewtalk( false );
3612 $id = $this->getId();
3614 $dbw = wfGetDB( DB_MASTER
);
3615 $dbw->update( 'watchlist',
3616 [ /* SET */ 'wl_notificationtimestamp' => null ],
3617 [ /* WHERE */ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ],
3620 // We also need to clear here the "you have new message" notification for the own user_talk page;
3621 // it's cleared one page view later in WikiPage::doViewUpdates().
3626 * Set a cookie on the user's client. Wrapper for
3627 * WebResponse::setCookie
3628 * @deprecated since 1.27
3629 * @param string $name Name of the cookie to set
3630 * @param string $value Value to set
3631 * @param int $exp Expiration time, as a UNIX time value;
3632 * if 0 or not specified, use the default $wgCookieExpiration
3633 * @param bool $secure
3634 * true: Force setting the secure attribute when setting the cookie
3635 * false: Force NOT setting the secure attribute when setting the cookie
3636 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3637 * @param array $params Array of options sent passed to WebResponse::setcookie()
3638 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3641 protected function setCookie(
3642 $name, $value, $exp = 0, $secure = null, $params = [], $request = null
3644 wfDeprecated( __METHOD__
, '1.27' );
3645 if ( $request === null ) {
3646 $request = $this->getRequest();
3648 $params['secure'] = $secure;
3649 $request->response()->setCookie( $name, $value, $exp, $params );
3653 * Clear a cookie on the user's client
3654 * @deprecated since 1.27
3655 * @param string $name Name of the cookie to clear
3656 * @param bool $secure
3657 * true: Force setting the secure attribute when setting the cookie
3658 * false: Force NOT setting the secure attribute when setting the cookie
3659 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3660 * @param array $params Array of options sent passed to WebResponse::setcookie()
3662 protected function clearCookie( $name, $secure = null, $params = [] ) {
3663 wfDeprecated( __METHOD__
, '1.27' );
3664 $this->setCookie( $name, '', time() - 86400, $secure, $params );
3668 * Set an extended login cookie on the user's client. The expiry of the cookie
3669 * is controlled by the $wgExtendedLoginCookieExpiration configuration
3672 * @see User::setCookie
3674 * @deprecated since 1.27
3675 * @param string $name Name of the cookie to set
3676 * @param string $value Value to set
3677 * @param bool $secure
3678 * true: Force setting the secure attribute when setting the cookie
3679 * false: Force NOT setting the secure attribute when setting the cookie
3680 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3682 protected function setExtendedLoginCookie( $name, $value, $secure ) {
3683 global $wgExtendedLoginCookieExpiration, $wgCookieExpiration;
3685 wfDeprecated( __METHOD__
, '1.27' );
3688 $exp +
= $wgExtendedLoginCookieExpiration !== null
3689 ?
$wgExtendedLoginCookieExpiration
3690 : $wgCookieExpiration;
3692 $this->setCookie( $name, $value, $exp, $secure );
3696 * Persist this user's session (e.g. set cookies)
3698 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3700 * @param bool $secure Whether to force secure/insecure cookies or use default
3701 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3703 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3705 if ( 0 == $this->mId
) {
3709 $session = $this->getRequest()->getSession();
3710 if ( $request && $session->getRequest() !== $request ) {
3711 $session = $session->sessionWithRequest( $request );
3713 $delay = $session->delaySave();
3715 if ( !$session->getUser()->equals( $this ) ) {
3716 if ( !$session->canSetUser() ) {
3717 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3718 ->warning( __METHOD__
.
3719 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
3723 $session->setUser( $this );
3726 $session->setRememberUser( $rememberMe );
3727 if ( $secure !== null ) {
3728 $session->setForceHTTPS( $secure );
3731 $session->persist();
3733 ScopedCallback
::consume( $delay );
3737 * Log this user out.
3739 public function logout() {
3740 if ( Hooks
::run( 'UserLogout', [ &$this ] ) ) {
3746 * Clear the user's session, and reset the instance cache.
3749 public function doLogout() {
3750 $session = $this->getRequest()->getSession();
3751 if ( !$session->canSetUser() ) {
3752 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3753 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
3754 $error = 'immutable';
3755 } elseif ( !$session->getUser()->equals( $this ) ) {
3756 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3757 ->warning( __METHOD__
.
3758 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
3760 // But we still may as well make this user object anon
3761 $this->clearInstanceCache( 'defaults' );
3762 $error = 'wronguser';
3764 $this->clearInstanceCache( 'defaults' );
3765 $delay = $session->delaySave();
3766 $session->unpersist(); // Clear cookies (T127436)
3767 $session->setLoggedOutTimestamp( time() );
3768 $session->setUser( new User
);
3769 $session->set( 'wsUserID', 0 ); // Other code expects this
3770 $session->resetAllTokens();
3771 ScopedCallback
::consume( $delay );
3774 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
3775 'event' => 'logout',
3776 'successful' => $error === false,
3777 'status' => $error ?
: 'success',
3782 * Save this user's settings into the database.
3783 * @todo Only rarely do all these fields need to be set!
3785 public function saveSettings() {
3786 if ( wfReadOnly() ) {
3787 // @TODO: caller should deal with this instead!
3788 // This should really just be an exception.
3789 MWExceptionHandler
::logException( new DBExpectedError(
3791 "Could not update user with ID '{$this->mId}'; DB is read-only."
3797 if ( 0 == $this->mId
) {
3801 // Get a new user_touched that is higher than the old one.
3802 // This will be used for a CAS check as a last-resort safety
3803 // check against race conditions and slave lag.
3804 $newTouched = $this->newTouchedTimestamp();
3806 $dbw = wfGetDB( DB_MASTER
);
3807 $dbw->update( 'user',
3809 'user_name' => $this->mName
,
3810 'user_real_name' => $this->mRealName
,
3811 'user_email' => $this->mEmail
,
3812 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3813 'user_touched' => $dbw->timestamp( $newTouched ),
3814 'user_token' => strval( $this->mToken
),
3815 'user_email_token' => $this->mEmailToken
,
3816 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
3817 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
3818 'user_id' => $this->mId
,
3822 if ( !$dbw->affectedRows() ) {
3823 // Maybe the problem was a missed cache update; clear it to be safe
3824 $this->clearSharedCache( 'refresh' );
3825 // User was changed in the meantime or loaded with stale data
3826 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'slave';
3827 throw new MWException(
3828 "CAS update failed on user_touched for user ID '{$this->mId}' (read from $from);" .
3829 " the version of the user to be saved is older than the current version."
3833 $this->mTouched
= $newTouched;
3834 $this->saveOptions();
3836 Hooks
::run( 'UserSaveSettings', [ $this ] );
3837 $this->clearSharedCache();
3838 $this->getUserPage()->invalidateCache();
3842 * If only this user's username is known, and it exists, return the user ID.
3844 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
3847 public function idForName( $flags = 0 ) {
3848 $s = trim( $this->getName() );
3853 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
3854 ?
wfGetDB( DB_MASTER
)
3855 : wfGetDB( DB_SLAVE
);
3857 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
3858 ?
[ 'LOCK IN SHARE MODE' ]
3861 $id = $db->selectField( 'user',
3862 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
3868 * Add a user to the database, return the user object
3870 * @param string $name Username to add
3871 * @param array $params Array of Strings Non-default parameters to save to
3872 * the database as user_* fields:
3873 * - email: The user's email address.
3874 * - email_authenticated: The email authentication timestamp.
3875 * - real_name: The user's real name.
3876 * - options: An associative array of non-default options.
3877 * - token: Random authentication token. Do not set.
3878 * - registration: Registration timestamp. Do not set.
3880 * @return User|null User object, or null if the username already exists.
3882 public static function createNew( $name, $params = [] ) {
3883 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
3884 if ( isset( $params[$field] ) ) {
3885 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
3886 unset( $params[$field] );
3892 $user->setToken(); // init token
3893 if ( isset( $params['options'] ) ) {
3894 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
3895 unset( $params['options'] );
3897 $dbw = wfGetDB( DB_MASTER
);
3898 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3900 $noPass = PasswordFactory
::newInvalidPassword()->toString();
3903 'user_id' => $seqVal,
3904 'user_name' => $name,
3905 'user_password' => $noPass,
3906 'user_newpassword' => $noPass,
3907 'user_email' => $user->mEmail
,
3908 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
3909 'user_real_name' => $user->mRealName
,
3910 'user_token' => strval( $user->mToken
),
3911 'user_registration' => $dbw->timestamp( $user->mRegistration
),
3912 'user_editcount' => 0,
3913 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
3915 foreach ( $params as $name => $value ) {
3916 $fields["user_$name"] = $value;
3918 $dbw->insert( 'user', $fields, __METHOD__
, [ 'IGNORE' ] );
3919 if ( $dbw->affectedRows() ) {
3920 $newUser = User
::newFromId( $dbw->insertId() );
3928 * Add this existing user object to the database. If the user already
3929 * exists, a fatal status object is returned, and the user object is
3930 * initialised with the data from the database.
3932 * Previously, this function generated a DB error due to a key conflict
3933 * if the user already existed. Many extension callers use this function
3934 * in code along the lines of:
3936 * $user = User::newFromName( $name );
3937 * if ( !$user->isLoggedIn() ) {
3938 * $user->addToDatabase();
3940 * // do something with $user...
3942 * However, this was vulnerable to a race condition (bug 16020). By
3943 * initialising the user object if the user exists, we aim to support this
3944 * calling sequence as far as possible.
3946 * Note that if the user exists, this function will acquire a write lock,
3947 * so it is still advisable to make the call conditional on isLoggedIn(),
3948 * and to commit the transaction after calling.
3950 * @throws MWException
3953 public function addToDatabase() {
3955 if ( !$this->mToken
) {
3956 $this->setToken(); // init token
3959 $this->mTouched
= $this->newTouchedTimestamp();
3961 $noPass = PasswordFactory
::newInvalidPassword()->toString();
3963 $dbw = wfGetDB( DB_MASTER
);
3964 $inWrite = $dbw->writesOrCallbacksPending();
3965 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3966 $dbw->insert( 'user',
3968 'user_id' => $seqVal,
3969 'user_name' => $this->mName
,
3970 'user_password' => $noPass,
3971 'user_newpassword' => $noPass,
3972 'user_email' => $this->mEmail
,
3973 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3974 'user_real_name' => $this->mRealName
,
3975 'user_token' => strval( $this->mToken
),
3976 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3977 'user_editcount' => 0,
3978 'user_touched' => $dbw->timestamp( $this->mTouched
),
3982 if ( !$dbw->affectedRows() ) {
3983 // The queries below cannot happen in the same REPEATABLE-READ snapshot.
3984 // Handle this by COMMIT, if possible, or by LOCK IN SHARE MODE otherwise.
3986 // Can't commit due to pending writes that may need atomicity.
3987 // This may cause some lock contention unlike the case below.
3988 $options = [ 'LOCK IN SHARE MODE' ];
3989 $flags = self
::READ_LOCKING
;
3991 // Often, this case happens early in views before any writes when
3992 // using CentralAuth. It's should be OK to commit and break the snapshot.
3993 $dbw->commit( __METHOD__
, 'flush' );
3995 $flags = self
::READ_LATEST
;
3997 $this->mId
= $dbw->selectField( 'user', 'user_id',
3998 [ 'user_name' => $this->mName
], __METHOD__
, $options );
4001 if ( $this->loadFromDatabase( $flags ) ) {
4006 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
4007 "to insert user '{$this->mName}' row, but it was not present in select!" );
4009 return Status
::newFatal( 'userexists' );
4011 $this->mId
= $dbw->insertId();
4012 self
::$idCacheByName[$this->mName
] = $this->mId
;
4014 // Clear instance cache other than user table data, which is already accurate
4015 $this->clearInstanceCache();
4017 $this->saveOptions();
4018 return Status
::newGood();
4022 * If this user is logged-in and blocked,
4023 * block any IP address they've successfully logged in from.
4024 * @return bool A block was spread
4026 public function spreadAnyEditBlock() {
4027 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4028 return $this->spreadBlock();
4035 * If this (non-anonymous) user is blocked,
4036 * block the IP address they've successfully logged in from.
4037 * @return bool A block was spread
4039 protected function spreadBlock() {
4040 wfDebug( __METHOD__
. "()\n" );
4042 if ( $this->mId
== 0 ) {
4046 $userblock = Block
::newFromTarget( $this->getName() );
4047 if ( !$userblock ) {
4051 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4055 * Get whether the user is explicitly blocked from account creation.
4056 * @return bool|Block
4058 public function isBlockedFromCreateAccount() {
4059 $this->getBlockedStatus();
4060 if ( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
4061 return $this->mBlock
;
4064 # bug 13611: if the IP address the user is trying to create an account from is
4065 # blocked with createaccount disabled, prevent new account creation there even
4066 # when the user is logged in
4067 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4068 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4070 return $this->mBlockedFromCreateAccount
instanceof Block
4071 && $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
4072 ?
$this->mBlockedFromCreateAccount
4077 * Get whether the user is blocked from using Special:Emailuser.
4080 public function isBlockedFromEmailuser() {
4081 $this->getBlockedStatus();
4082 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
4086 * Get whether the user is allowed to create an account.
4089 public function isAllowedToCreateAccount() {
4090 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4094 * Get this user's personal page title.
4096 * @return Title User's personal page title
4098 public function getUserPage() {
4099 return Title
::makeTitle( NS_USER
, $this->getName() );
4103 * Get this user's talk page title.
4105 * @return Title User's talk page title
4107 public function getTalkPage() {
4108 $title = $this->getUserPage();
4109 return $title->getTalkPage();
4113 * Determine whether the user is a newbie. Newbies are either
4114 * anonymous IPs, or the most recently created accounts.
4117 public function isNewbie() {
4118 return !$this->isAllowed( 'autoconfirmed' );
4122 * Check to see if the given clear-text password is one of the accepted passwords
4123 * @deprecated since 1.27, use AuthManager instead
4124 * @param string $password User password
4125 * @return bool True if the given password is correct, otherwise False
4127 public function checkPassword( $password ) {
4128 $manager = AuthManager
::singleton();
4129 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4130 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4132 'username' => $this->getName(),
4133 'password' => $password,
4136 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4137 switch ( $res->status
) {
4138 case AuthenticationResponse
::PASS
:
4140 case AuthenticationResponse
::FAIL
:
4141 // Hope it's not a PreAuthenticationProvider that failed...
4142 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4143 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4146 throw new BadMethodCallException(
4147 'AuthManager returned a response unsupported by ' . __METHOD__
4153 * Check if the given clear-text password matches the temporary password
4154 * sent by e-mail for password reset operations.
4156 * @deprecated since 1.27, use AuthManager instead
4157 * @param string $plaintext
4158 * @return bool True if matches, false otherwise
4160 public function checkTemporaryPassword( $plaintext ) {
4161 // Can't check the temporary password individually.
4162 return $this->checkPassword( $plaintext );
4166 * Initialize (if necessary) and return a session token value
4167 * which can be used in edit forms to show that the user's
4168 * login credentials aren't being hijacked with a foreign form
4172 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4173 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4174 * @return MediaWiki\Session\Token The new edit token
4176 public function getEditTokenObject( $salt = '', $request = null ) {
4177 if ( $this->isAnon() ) {
4178 return new LoggedOutEditToken();
4182 $request = $this->getRequest();
4184 return $request->getSession()->getToken( $salt );
4188 * Initialize (if necessary) and return a session token value
4189 * which can be used in edit forms to show that the user's
4190 * login credentials aren't being hijacked with a foreign form
4193 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4196 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4197 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4198 * @return string The new edit token
4200 public function getEditToken( $salt = '', $request = null ) {
4201 return $this->getEditTokenObject( $salt, $request )->toString();
4205 * Get the embedded timestamp from a token.
4206 * @deprecated since 1.27, use \MediaWiki\Session\Token::getTimestamp instead.
4207 * @param string $val Input token
4210 public static function getEditTokenTimestamp( $val ) {
4211 wfDeprecated( __METHOD__
, '1.27' );
4212 return MediaWiki\Session\Token
::getTimestamp( $val );
4216 * Check given value against the token value stored in the session.
4217 * A match should confirm that the form was submitted from the
4218 * user's own login session, not a form submission from a third-party
4221 * @param string $val Input value to compare
4222 * @param string $salt Optional function-specific data for hashing
4223 * @param WebRequest|null $request Object to use or null to use $wgRequest
4224 * @param int $maxage Fail tokens older than this, in seconds
4225 * @return bool Whether the token matches
4227 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4228 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4232 * Check given value against the token value stored in the session,
4233 * ignoring the suffix.
4235 * @param string $val Input value to compare
4236 * @param string $salt Optional function-specific data for hashing
4237 * @param WebRequest|null $request Object to use or null to use $wgRequest
4238 * @param int $maxage Fail tokens older than this, in seconds
4239 * @return bool Whether the token matches
4241 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4242 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4243 return $this->matchEditToken( $val, $salt, $request, $maxage );
4247 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4248 * mail to the user's given address.
4250 * @param string $type Message to send, either "created", "changed" or "set"
4253 public function sendConfirmationMail( $type = 'created' ) {
4255 $expiration = null; // gets passed-by-ref and defined in next line.
4256 $token = $this->confirmationToken( $expiration );
4257 $url = $this->confirmationTokenUrl( $token );
4258 $invalidateURL = $this->invalidationTokenUrl( $token );
4259 $this->saveSettings();
4261 if ( $type == 'created' ||
$type === false ) {
4262 $message = 'confirmemail_body';
4263 } elseif ( $type === true ) {
4264 $message = 'confirmemail_body_changed';
4266 // Messages: confirmemail_body_changed, confirmemail_body_set
4267 $message = 'confirmemail_body_' . $type;
4270 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4271 wfMessage( $message,
4272 $this->getRequest()->getIP(),
4275 $wgLang->userTimeAndDate( $expiration, $this ),
4277 $wgLang->userDate( $expiration, $this ),
4278 $wgLang->userTime( $expiration, $this ) )->text() );
4282 * Send an e-mail to this user's account. Does not check for
4283 * confirmed status or validity.
4285 * @param string $subject Message subject
4286 * @param string $body Message body
4287 * @param User|null $from Optional sending user; if unspecified, default
4288 * $wgPasswordSender will be used.
4289 * @param string $replyto Reply-To address
4292 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4293 global $wgPasswordSender;
4295 if ( $from instanceof User
) {
4296 $sender = MailAddress
::newFromUser( $from );
4298 $sender = new MailAddress( $wgPasswordSender,
4299 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4301 $to = MailAddress
::newFromUser( $this );
4303 return UserMailer
::send( $to, $sender, $subject, $body, [
4304 'replyTo' => $replyto,
4309 * Generate, store, and return a new e-mail confirmation code.
4310 * A hash (unsalted, since it's used as a key) is stored.
4312 * @note Call saveSettings() after calling this function to commit
4313 * this change to the database.
4315 * @param string &$expiration Accepts the expiration time
4316 * @return string New token
4318 protected function confirmationToken( &$expiration ) {
4319 global $wgUserEmailConfirmationTokenExpiry;
4321 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4322 $expiration = wfTimestamp( TS_MW
, $expires );
4324 $token = MWCryptRand
::generateHex( 32 );
4325 $hash = md5( $token );
4326 $this->mEmailToken
= $hash;
4327 $this->mEmailTokenExpires
= $expiration;
4332 * Return a URL the user can use to confirm their email address.
4333 * @param string $token Accepts the email confirmation token
4334 * @return string New token URL
4336 protected function confirmationTokenUrl( $token ) {
4337 return $this->getTokenUrl( 'ConfirmEmail', $token );
4341 * Return a URL the user can use to invalidate their email address.
4342 * @param string $token Accepts the email confirmation token
4343 * @return string New token URL
4345 protected function invalidationTokenUrl( $token ) {
4346 return $this->getTokenUrl( 'InvalidateEmail', $token );
4350 * Internal function to format the e-mail validation/invalidation URLs.
4351 * This uses a quickie hack to use the
4352 * hardcoded English names of the Special: pages, for ASCII safety.
4354 * @note Since these URLs get dropped directly into emails, using the
4355 * short English names avoids insanely long URL-encoded links, which
4356 * also sometimes can get corrupted in some browsers/mailers
4357 * (bug 6957 with Gmail and Internet Explorer).
4359 * @param string $page Special page
4360 * @param string $token Token
4361 * @return string Formatted URL
4363 protected function getTokenUrl( $page, $token ) {
4364 // Hack to bypass localization of 'Special:'
4365 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4366 return $title->getCanonicalURL();
4370 * Mark the e-mail address confirmed.
4372 * @note Call saveSettings() after calling this function to commit the change.
4376 public function confirmEmail() {
4377 // Check if it's already confirmed, so we don't touch the database
4378 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4379 if ( !$this->isEmailConfirmed() ) {
4380 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4381 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4387 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4388 * address if it was already confirmed.
4390 * @note Call saveSettings() after calling this function to commit the change.
4391 * @return bool Returns true
4393 public function invalidateEmail() {
4395 $this->mEmailToken
= null;
4396 $this->mEmailTokenExpires
= null;
4397 $this->setEmailAuthenticationTimestamp( null );
4399 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4404 * Set the e-mail authentication timestamp.
4405 * @param string $timestamp TS_MW timestamp
4407 public function setEmailAuthenticationTimestamp( $timestamp ) {
4409 $this->mEmailAuthenticated
= $timestamp;
4410 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4414 * Is this user allowed to send e-mails within limits of current
4415 * site configuration?
4418 public function canSendEmail() {
4419 global $wgEnableEmail, $wgEnableUserEmail;
4420 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4423 $canSend = $this->isEmailConfirmed();
4424 Hooks
::run( 'UserCanSendEmail', [ &$this, &$canSend ] );
4429 * Is this user allowed to receive e-mails within limits of current
4430 * site configuration?
4433 public function canReceiveEmail() {
4434 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4438 * Is this user's e-mail address valid-looking and confirmed within
4439 * limits of the current site configuration?
4441 * @note If $wgEmailAuthentication is on, this may require the user to have
4442 * confirmed their address by returning a code or using a password
4443 * sent to the address from the wiki.
4447 public function isEmailConfirmed() {
4448 global $wgEmailAuthentication;
4451 if ( Hooks
::run( 'EmailConfirmed', [ &$this, &$confirmed ] ) ) {
4452 if ( $this->isAnon() ) {
4455 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4458 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4468 * Check whether there is an outstanding request for e-mail confirmation.
4471 public function isEmailConfirmationPending() {
4472 global $wgEmailAuthentication;
4473 return $wgEmailAuthentication &&
4474 !$this->isEmailConfirmed() &&
4475 $this->mEmailToken
&&
4476 $this->mEmailTokenExpires
> wfTimestamp();
4480 * Get the timestamp of account creation.
4482 * @return string|bool|null Timestamp of account creation, false for
4483 * non-existent/anonymous user accounts, or null if existing account
4484 * but information is not in database.
4486 public function getRegistration() {
4487 if ( $this->isAnon() ) {
4491 return $this->mRegistration
;
4495 * Get the timestamp of the first edit
4497 * @return string|bool Timestamp of first edit, or false for
4498 * non-existent/anonymous user accounts.
4500 public function getFirstEditTimestamp() {
4501 if ( $this->getId() == 0 ) {
4502 return false; // anons
4504 $dbr = wfGetDB( DB_SLAVE
);
4505 $time = $dbr->selectField( 'revision', 'rev_timestamp',
4506 [ 'rev_user' => $this->getId() ],
4508 [ 'ORDER BY' => 'rev_timestamp ASC' ]
4511 return false; // no edits
4513 return wfTimestamp( TS_MW
, $time );
4517 * Get the permissions associated with a given list of groups
4519 * @param array $groups Array of Strings List of internal group names
4520 * @return array Array of Strings List of permission key names for given groups combined
4522 public static function getGroupPermissions( $groups ) {
4523 global $wgGroupPermissions, $wgRevokePermissions;
4525 // grant every granted permission first
4526 foreach ( $groups as $group ) {
4527 if ( isset( $wgGroupPermissions[$group] ) ) {
4528 $rights = array_merge( $rights,
4529 // array_filter removes empty items
4530 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4533 // now revoke the revoked permissions
4534 foreach ( $groups as $group ) {
4535 if ( isset( $wgRevokePermissions[$group] ) ) {
4536 $rights = array_diff( $rights,
4537 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4540 return array_unique( $rights );
4544 * Get all the groups who have a given permission
4546 * @param string $role Role to check
4547 * @return array Array of Strings List of internal group names with the given permission
4549 public static function getGroupsWithPermission( $role ) {
4550 global $wgGroupPermissions;
4551 $allowedGroups = [];
4552 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4553 if ( self
::groupHasPermission( $group, $role ) ) {
4554 $allowedGroups[] = $group;
4557 return $allowedGroups;
4561 * Check, if the given group has the given permission
4563 * If you're wanting to check whether all users have a permission, use
4564 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4568 * @param string $group Group to check
4569 * @param string $role Role to check
4572 public static function groupHasPermission( $group, $role ) {
4573 global $wgGroupPermissions, $wgRevokePermissions;
4574 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4575 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4579 * Check if all users may be assumed to have the given permission
4581 * We generally assume so if the right is granted to '*' and isn't revoked
4582 * on any group. It doesn't attempt to take grants or other extension
4583 * limitations on rights into account in the general case, though, as that
4584 * would require it to always return false and defeat the purpose.
4585 * Specifically, session-based rights restrictions (such as OAuth or bot
4586 * passwords) are applied based on the current session.
4589 * @param string $right Right to check
4592 public static function isEveryoneAllowed( $right ) {
4593 global $wgGroupPermissions, $wgRevokePermissions;
4596 // Use the cached results, except in unit tests which rely on
4597 // being able change the permission mid-request
4598 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
4599 return $cache[$right];
4602 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
4603 $cache[$right] = false;
4607 // If it's revoked anywhere, then everyone doesn't have it
4608 foreach ( $wgRevokePermissions as $rights ) {
4609 if ( isset( $rights[$right] ) && $rights[$right] ) {
4610 $cache[$right] = false;
4615 // Remove any rights that aren't allowed to the global-session user,
4616 // unless there are no sessions for this endpoint.
4617 if ( !defined( 'MW_NO_SESSION' ) ) {
4618 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
4619 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
4620 $cache[$right] = false;
4625 // Allow extensions to say false
4626 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
4627 $cache[$right] = false;
4631 $cache[$right] = true;
4636 * Get the localized descriptive name for a group, if it exists
4638 * @param string $group Internal group name
4639 * @return string Localized descriptive group name
4641 public static function getGroupName( $group ) {
4642 $msg = wfMessage( "group-$group" );
4643 return $msg->isBlank() ?
$group : $msg->text();
4647 * Get the localized descriptive name for a member of a group, if it exists
4649 * @param string $group Internal group name
4650 * @param string $username Username for gender (since 1.19)
4651 * @return string Localized name for group member
4653 public static function getGroupMember( $group, $username = '#' ) {
4654 $msg = wfMessage( "group-$group-member", $username );
4655 return $msg->isBlank() ?
$group : $msg->text();
4659 * Return the set of defined explicit groups.
4660 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4661 * are not included, as they are defined automatically, not in the database.
4662 * @return array Array of internal group names
4664 public static function getAllGroups() {
4665 global $wgGroupPermissions, $wgRevokePermissions;
4667 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4668 self
::getImplicitGroups()
4673 * Get a list of all available permissions.
4674 * @return string[] Array of permission names
4676 public static function getAllRights() {
4677 if ( self
::$mAllRights === false ) {
4678 global $wgAvailableRights;
4679 if ( count( $wgAvailableRights ) ) {
4680 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
4682 self
::$mAllRights = self
::$mCoreRights;
4684 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
4686 return self
::$mAllRights;
4690 * Get a list of implicit groups
4691 * @return array Array of Strings Array of internal group names
4693 public static function getImplicitGroups() {
4694 global $wgImplicitGroups;
4696 $groups = $wgImplicitGroups;
4697 # Deprecated, use $wgImplicitGroups instead
4698 Hooks
::run( 'UserGetImplicitGroups', [ &$groups ], '1.25' );
4704 * Get the title of a page describing a particular group
4706 * @param string $group Internal group name
4707 * @return Title|bool Title of the page if it exists, false otherwise
4709 public static function getGroupPage( $group ) {
4710 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
4711 if ( $msg->exists() ) {
4712 $title = Title
::newFromText( $msg->text() );
4713 if ( is_object( $title ) ) {
4721 * Create a link to the group in HTML, if available;
4722 * else return the group name.
4724 * @param string $group Internal name of the group
4725 * @param string $text The text of the link
4726 * @return string HTML link to the group
4728 public static function makeGroupLinkHTML( $group, $text = '' ) {
4729 if ( $text == '' ) {
4730 $text = self
::getGroupName( $group );
4732 $title = self
::getGroupPage( $group );
4734 return Linker
::link( $title, htmlspecialchars( $text ) );
4736 return htmlspecialchars( $text );
4741 * Create a link to the group in Wikitext, if available;
4742 * else return the group name.
4744 * @param string $group Internal name of the group
4745 * @param string $text The text of the link
4746 * @return string Wikilink to the group
4748 public static function makeGroupLinkWiki( $group, $text = '' ) {
4749 if ( $text == '' ) {
4750 $text = self
::getGroupName( $group );
4752 $title = self
::getGroupPage( $group );
4754 $page = $title->getFullText();
4755 return "[[$page|$text]]";
4762 * Returns an array of the groups that a particular group can add/remove.
4764 * @param string $group The group to check for whether it can add/remove
4765 * @return array Array( 'add' => array( addablegroups ),
4766 * 'remove' => array( removablegroups ),
4767 * 'add-self' => array( addablegroups to self),
4768 * 'remove-self' => array( removable groups from self) )
4770 public static function changeableByGroup( $group ) {
4771 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4780 if ( empty( $wgAddGroups[$group] ) ) {
4781 // Don't add anything to $groups
4782 } elseif ( $wgAddGroups[$group] === true ) {
4783 // You get everything
4784 $groups['add'] = self
::getAllGroups();
4785 } elseif ( is_array( $wgAddGroups[$group] ) ) {
4786 $groups['add'] = $wgAddGroups[$group];
4789 // Same thing for remove
4790 if ( empty( $wgRemoveGroups[$group] ) ) {
4792 } elseif ( $wgRemoveGroups[$group] === true ) {
4793 $groups['remove'] = self
::getAllGroups();
4794 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4795 $groups['remove'] = $wgRemoveGroups[$group];
4798 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4799 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
4800 foreach ( $wgGroupsAddToSelf as $key => $value ) {
4801 if ( is_int( $key ) ) {
4802 $wgGroupsAddToSelf['user'][] = $value;
4807 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
4808 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4809 if ( is_int( $key ) ) {
4810 $wgGroupsRemoveFromSelf['user'][] = $value;
4815 // Now figure out what groups the user can add to him/herself
4816 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
4818 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
4819 // No idea WHY this would be used, but it's there
4820 $groups['add-self'] = User
::getAllGroups();
4821 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4822 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4825 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4827 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4828 $groups['remove-self'] = User
::getAllGroups();
4829 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4830 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4837 * Returns an array of groups that this user can add and remove
4838 * @return array Array( 'add' => array( addablegroups ),
4839 * 'remove' => array( removablegroups ),
4840 * 'add-self' => array( addablegroups to self),
4841 * 'remove-self' => array( removable groups from self) )
4843 public function changeableGroups() {
4844 if ( $this->isAllowed( 'userrights' ) ) {
4845 // This group gives the right to modify everything (reverse-
4846 // compatibility with old "userrights lets you change
4848 // Using array_merge to make the groups reindexed
4849 $all = array_merge( User
::getAllGroups() );
4858 // Okay, it's not so simple, we will have to go through the arrays
4865 $addergroups = $this->getEffectiveGroups();
4867 foreach ( $addergroups as $addergroup ) {
4868 $groups = array_merge_recursive(
4869 $groups, $this->changeableByGroup( $addergroup )
4871 $groups['add'] = array_unique( $groups['add'] );
4872 $groups['remove'] = array_unique( $groups['remove'] );
4873 $groups['add-self'] = array_unique( $groups['add-self'] );
4874 $groups['remove-self'] = array_unique( $groups['remove-self'] );
4880 * Deferred version of incEditCountImmediate()
4882 public function incEditCount() {
4883 wfGetDB( DB_MASTER
)->onTransactionPreCommitOrIdle( function() {
4884 $this->incEditCountImmediate();
4889 * Increment the user's edit-count field.
4890 * Will have no effect for anonymous users.
4893 public function incEditCountImmediate() {
4894 if ( $this->isAnon() ) {
4898 $dbw = wfGetDB( DB_MASTER
);
4899 // No rows will be "affected" if user_editcount is NULL
4902 [ 'user_editcount=user_editcount+1' ],
4903 [ 'user_id' => $this->getId(), 'user_editcount IS NOT NULL' ],
4906 // Lazy initialization check...
4907 if ( $dbw->affectedRows() == 0 ) {
4908 // Now here's a goddamn hack...
4909 $dbr = wfGetDB( DB_SLAVE
);
4910 if ( $dbr !== $dbw ) {
4911 // If we actually have a slave server, the count is
4912 // at least one behind because the current transaction
4913 // has not been committed and replicated.
4914 $this->mEditCount
= $this->initEditCount( 1 );
4916 // But if DB_SLAVE is selecting the master, then the
4917 // count we just read includes the revision that was
4918 // just added in the working transaction.
4919 $this->mEditCount
= $this->initEditCount();
4922 if ( $this->mEditCount
=== null ) {
4923 $this->getEditCount();
4924 $dbr = wfGetDB( DB_SLAVE
);
4925 $this->mEditCount +
= ( $dbr !== $dbw ) ?
1 : 0;
4927 $this->mEditCount++
;
4930 // Edit count in user cache too
4931 $this->invalidateCache();
4935 * Initialize user_editcount from data out of the revision table
4937 * @param int $add Edits to add to the count from the revision table
4938 * @return int Number of edits
4940 protected function initEditCount( $add = 0 ) {
4941 // Pull from a slave to be less cruel to servers
4942 // Accuracy isn't the point anyway here
4943 $dbr = wfGetDB( DB_SLAVE
);
4944 $count = (int)$dbr->selectField(
4947 [ 'rev_user' => $this->getId() ],
4950 $count = $count +
$add;
4952 $dbw = wfGetDB( DB_MASTER
);
4955 [ 'user_editcount' => $count ],
4956 [ 'user_id' => $this->getId() ],
4964 * Get the description of a given right
4966 * @param string $right Right to query
4967 * @return string Localized description of the right
4969 public static function getRightDescription( $right ) {
4970 $key = "right-$right";
4971 $msg = wfMessage( $key );
4972 return $msg->isBlank() ?
$right : $msg->text();
4976 * Make a new-style password hash
4978 * @param string $password Plain-text password
4979 * @param bool|string $salt Optional salt, may be random or the user ID.
4980 * If unspecified or false, will generate one automatically
4981 * @return string Password hash
4982 * @deprecated since 1.24, use Password class
4984 public static function crypt( $password, $salt = false ) {
4985 wfDeprecated( __METHOD__
, '1.24' );
4986 $passwordFactory = new PasswordFactory();
4987 $passwordFactory->init( RequestContext
::getMain()->getConfig() );
4988 $hash = $passwordFactory->newFromPlaintext( $password );
4989 return $hash->toString();
4993 * Compare a password hash with a plain-text password. Requires the user
4994 * ID if there's a chance that the hash is an old-style hash.
4996 * @param string $hash Password hash
4997 * @param string $password Plain-text password to compare
4998 * @param string|bool $userId User ID for old-style password salt
5001 * @deprecated since 1.24, use Password class
5003 public static function comparePasswords( $hash, $password, $userId = false ) {
5004 wfDeprecated( __METHOD__
, '1.24' );
5006 // Check for *really* old password hashes that don't even have a type
5007 // The old hash format was just an md5 hex hash, with no type information
5008 if ( preg_match( '/^[0-9a-f]{32}$/', $hash ) ) {
5009 global $wgPasswordSalt;
5010 if ( $wgPasswordSalt ) {
5011 $password = ":B:{$userId}:{$hash}";
5013 $password = ":A:{$hash}";
5017 $passwordFactory = new PasswordFactory();
5018 $passwordFactory->init( RequestContext
::getMain()->getConfig() );
5019 $hash = $passwordFactory->newFromCiphertext( $hash );
5020 return $hash->equals( $password );
5024 * Add a newuser log entry for this user.
5025 * Before 1.19 the return value was always true.
5027 * @deprecated since 1.27, AuthManager handles logging
5028 * @param string|bool $action Account creation type.
5029 * - String, one of the following values:
5030 * - 'create' for an anonymous user creating an account for himself.
5031 * This will force the action's performer to be the created user itself,
5032 * no matter the value of $wgUser
5033 * - 'create2' for a logged in user creating an account for someone else
5034 * - 'byemail' when the created user will receive its password by e-mail
5035 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5036 * - Boolean means whether the account was created by e-mail (deprecated):
5037 * - true will be converted to 'byemail'
5038 * - false will be converted to 'create' if this object is the same as
5039 * $wgUser and to 'create2' otherwise
5040 * @param string $reason User supplied reason
5043 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5044 return true; // disabled
5048 * Add an autocreate newuser log entry for this user
5049 * Used by things like CentralAuth and perhaps other authplugins.
5050 * Consider calling addNewUserLogEntry() directly instead.
5052 * @deprecated since 1.27, AuthManager handles logging
5055 public function addNewUserLogEntryAutoCreate() {
5056 $this->addNewUserLogEntry( 'autocreate' );
5062 * Load the user options either from cache, the database or an array
5064 * @param array $data Rows for the current user out of the user_properties table
5066 protected function loadOptions( $data = null ) {
5071 if ( $this->mOptionsLoaded
) {
5075 $this->mOptions
= self
::getDefaultOptions();
5077 if ( !$this->getId() ) {
5078 // For unlogged-in users, load language/variant options from request.
5079 // There's no need to do it for logged-in users: they can set preferences,
5080 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5081 // so don't override user's choice (especially when the user chooses site default).
5082 $variant = $wgContLang->getDefaultVariant();
5083 $this->mOptions
['variant'] = $variant;
5084 $this->mOptions
['language'] = $variant;
5085 $this->mOptionsLoaded
= true;
5089 // Maybe load from the object
5090 if ( !is_null( $this->mOptionOverrides
) ) {
5091 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5092 foreach ( $this->mOptionOverrides
as $key => $value ) {
5093 $this->mOptions
[$key] = $value;
5096 if ( !is_array( $data ) ) {
5097 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5098 // Load from database
5099 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5100 ?
wfGetDB( DB_MASTER
)
5101 : wfGetDB( DB_SLAVE
);
5103 $res = $dbr->select(
5105 [ 'up_property', 'up_value' ],
5106 [ 'up_user' => $this->getId() ],
5110 $this->mOptionOverrides
= [];
5112 foreach ( $res as $row ) {
5113 $data[$row->up_property
] = $row->up_value
;
5116 foreach ( $data as $property => $value ) {
5117 $this->mOptionOverrides
[$property] = $value;
5118 $this->mOptions
[$property] = $value;
5122 $this->mOptionsLoaded
= true;
5124 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5128 * Saves the non-default options for this user, as previously set e.g. via
5129 * setOption(), in the database's "user_properties" (preferences) table.
5130 * Usually used via saveSettings().
5132 protected function saveOptions() {
5133 $this->loadOptions();
5135 // Not using getOptions(), to keep hidden preferences in database
5136 $saveOptions = $this->mOptions
;
5138 // Allow hooks to abort, for instance to save to a global profile.
5139 // Reset options to default state before saving.
5140 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5144 $userId = $this->getId();
5146 $insert_rows = []; // all the new preference rows
5147 foreach ( $saveOptions as $key => $value ) {
5148 // Don't bother storing default values
5149 $defaultOption = self
::getDefaultOption( $key );
5150 if ( ( $defaultOption === null && $value !== false && $value !== null )
5151 ||
$value != $defaultOption
5154 'up_user' => $userId,
5155 'up_property' => $key,
5156 'up_value' => $value,
5161 $dbw = wfGetDB( DB_MASTER
);
5163 $res = $dbw->select( 'user_properties',
5164 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5166 // Find prior rows that need to be removed or updated. These rows will
5167 // all be deleted (the later so that INSERT IGNORE applies the new values).
5169 foreach ( $res as $row ) {
5170 if ( !isset( $saveOptions[$row->up_property
] )
5171 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5173 $keysDelete[] = $row->up_property
;
5177 if ( count( $keysDelete ) ) {
5178 // Do the DELETE by PRIMARY KEY for prior rows.
5179 // In the past a very large portion of calls to this function are for setting
5180 // 'rememberpassword' for new accounts (a preference that has since been removed).
5181 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5182 // caused gap locks on [max user ID,+infinity) which caused high contention since
5183 // updates would pile up on each other as they are for higher (newer) user IDs.
5184 // It might not be necessary these days, but it shouldn't hurt either.
5185 $dbw->delete( 'user_properties',
5186 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5188 // Insert the new preference rows
5189 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5193 * Lazily instantiate and return a factory object for making passwords
5195 * @deprecated since 1.27, create a PasswordFactory directly instead
5196 * @return PasswordFactory
5198 public static function getPasswordFactory() {
5199 wfDeprecated( __METHOD__
, '1.27' );
5200 $ret = new PasswordFactory();
5201 $ret->init( RequestContext
::getMain()->getConfig() );
5206 * Provide an array of HTML5 attributes to put on an input element
5207 * intended for the user to enter a new password. This may include
5208 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
5210 * Do *not* use this when asking the user to enter his current password!
5211 * Regardless of configuration, users may have invalid passwords for whatever
5212 * reason (e.g., they were set before requirements were tightened up).
5213 * Only use it when asking for a new password, like on account creation or
5216 * Obviously, you still need to do server-side checking.
5218 * NOTE: A combination of bugs in various browsers means that this function
5219 * actually just returns array() unconditionally at the moment. May as
5220 * well keep it around for when the browser bugs get fixed, though.
5222 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
5224 * @deprecated since 1.27
5225 * @return array Array of HTML attributes suitable for feeding to
5226 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
5227 * That will get confused by the boolean attribute syntax used.)
5229 public static function passwordChangeInputAttribs() {
5230 global $wgMinimalPasswordLength;
5232 if ( $wgMinimalPasswordLength == 0 ) {
5236 # Note that the pattern requirement will always be satisfied if the
5237 # input is empty, so we need required in all cases.
5239 # @todo FIXME: Bug 23769: This needs to not claim the password is required
5240 # if e-mail confirmation is being used. Since HTML5 input validation
5241 # is b0rked anyway in some browsers, just return nothing. When it's
5242 # re-enabled, fix this code to not output required for e-mail
5244 # $ret = array( 'required' );
5247 # We can't actually do this right now, because Opera 9.6 will print out
5248 # the entered password visibly in its error message! When other
5249 # browsers add support for this attribute, or Opera fixes its support,
5250 # we can add support with a version check to avoid doing this on Opera
5251 # versions where it will be a problem. Reported to Opera as
5252 # DSK-262266, but they don't have a public bug tracker for us to follow.
5254 if ( $wgMinimalPasswordLength > 1 ) {
5255 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
5256 $ret['title'] = wfMessage( 'passwordtooshort' )
5257 ->numParams( $wgMinimalPasswordLength )->text();
5265 * Return the list of user fields that should be selected to create
5266 * a new user object.
5269 public static function selectFields() {
5277 'user_email_authenticated',
5279 'user_email_token_expires',
5280 'user_registration',
5286 * Factory function for fatal permission-denied errors
5289 * @param string $permission User right required
5292 static function newFatalPermissionDeniedStatus( $permission ) {
5295 $groups = array_map(
5296 [ 'User', 'makeGroupLinkWiki' ],
5297 User
::getGroupsWithPermission( $permission )
5301 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5303 return Status
::newFatal( 'badaccess-group0' );
5308 * Get a new instance of this user that was loaded from the master via a locking read
5310 * Use this instead of the main context User when updating that user. This avoids races
5311 * where that user was loaded from a slave or even the master but without proper locks.
5313 * @return User|null Returns null if the user was not found in the DB
5316 public function getInstanceForUpdate() {
5317 if ( !$this->getId() ) {
5318 return null; // anon
5321 $user = self
::newFromId( $this->getId() );
5322 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5330 * Checks if two user objects point to the same user.
5336 public function equals( User
$user ) {
5337 return $this->getName() === $user->getName();