3 * Implements the User class for the %MediaWiki software.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\MediaWikiServices
;
24 use MediaWiki\Session\SessionManager
;
25 use MediaWiki\Session\Token
;
26 use MediaWiki\Auth\AuthManager
;
27 use MediaWiki\Auth\AuthenticationResponse
;
28 use MediaWiki\Auth\AuthenticationRequest
;
29 use Wikimedia\ScopedCallback
;
32 * String Some punctuation to prevent editing from broken text-mangling proxies.
33 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
36 define( 'EDIT_TOKEN_SUFFIX', Token
::SUFFIX
);
39 * The User object encapsulates all of the user-specific settings (user_id,
40 * name, rights, email address, options, last login time). Client
41 * classes use the getXXX() functions to access these fields. These functions
42 * do all the work of determining whether the user is logged in,
43 * whether the requested option can be satisfied from cookies or
44 * whether a database query is needed. Most of the settings needed
45 * for rendering normal pages are set in the cookie to minimize use
48 class User
implements IDBAccessObject
{
50 * @const int Number of characters in user_token field.
52 const TOKEN_LENGTH
= 32;
55 * @const string An invalid value for user_token
57 const INVALID_TOKEN
= '*** INVALID ***';
60 * Global constant made accessible as class constants so that autoloader
62 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
64 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
67 * @const int Serialized record version.
72 * Exclude user options that are set to their default value.
75 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
80 const CHECK_USER_RIGHTS
= true;
85 const IGNORE_USER_RIGHTS
= false;
88 * Array of Strings List of member variables which are saved to the
89 * shared cache (memcached). Any operation which changes the
90 * corresponding database fields must call a cache-clearing function.
93 protected static $mCacheVars = [
101 'mEmailAuthenticated',
103 'mEmailTokenExpires',
108 // user_properties table
113 * Array of Strings Core rights.
114 * Each of these should have a corresponding message of the form
118 protected static $mCoreRights = [
149 'editusercssjs', # deprecated
162 'move-categorypages',
163 'move-rootuserpages',
167 'override-export-depth',
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 /** @var string Indicates type of block (used for eventlogging)
304 * Permitted values: 'cookie-block', 'proxy-block', 'openproxy-block', 'xff-block'
306 public $blockTrigger = false;
308 public static $idCacheByName = [];
311 * Lightweight constructor for an anonymous user.
312 * Use the User::newFrom* factory functions for other kinds of users.
316 * @see newFromConfirmationCode()
317 * @see newFromSession()
320 public function __construct() {
321 $this->clearInstanceCache( 'defaults' );
327 public function __toString() {
328 return (string)$this->getName();
332 * Test if it's safe to load this User object.
334 * You should typically check this before using $wgUser or
335 * RequestContext::getUser in a method that might be called before the
336 * system has been fully initialized. If the object is unsafe, you should
337 * use an anonymous user:
339 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
345 public function isSafeToLoad() {
346 global $wgFullyInitialised;
348 // The user is safe to load if:
349 // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
350 // * mLoadedItems === true (already loaded)
351 // * mFrom !== 'session' (sessions not involved at all)
353 return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
354 $this->mLoadedItems
=== true ||
$this->mFrom
!== 'session';
358 * Load the user table data for this object from the source given by mFrom.
360 * @param integer $flags User::READ_* constant bitfield
362 public function load( $flags = self
::READ_NORMAL
) {
363 global $wgFullyInitialised;
365 if ( $this->mLoadedItems
=== true ) {
369 // Set it now to avoid infinite recursion in accessors
370 $oldLoadedItems = $this->mLoadedItems
;
371 $this->mLoadedItems
= true;
372 $this->queryFlagsUsed
= $flags;
374 // If this is called too early, things are likely to break.
375 if ( !$wgFullyInitialised && $this->mFrom
=== 'session' ) {
376 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
377 ->warning( 'User::loadFromSession called before the end of Setup.php', [
378 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
380 $this->loadDefaults();
381 $this->mLoadedItems
= $oldLoadedItems;
385 switch ( $this->mFrom
) {
387 $this->loadDefaults();
390 // Make sure this thread sees its own changes
391 if ( wfGetLB()->hasOrMadeRecentMasterChanges() ) {
392 $flags |
= self
::READ_LATEST
;
393 $this->queryFlagsUsed
= $flags;
396 $this->mId
= self
::idFromName( $this->mName
, $flags );
398 // Nonexistent user placeholder object
399 $this->loadDefaults( $this->mName
);
401 $this->loadFromId( $flags );
405 $this->loadFromId( $flags );
408 if ( !$this->loadFromSession() ) {
409 // Loading from session failed. Load defaults.
410 $this->loadDefaults();
412 Hooks
::run( 'UserLoadAfterLoadFromSession', [ $this ] );
415 throw new UnexpectedValueException(
416 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
421 * Load user table data, given mId has already been set.
422 * @param integer $flags User::READ_* constant bitfield
423 * @return bool False if the ID does not exist, true otherwise
425 public function loadFromId( $flags = self
::READ_NORMAL
) {
426 if ( $this->mId
== 0 ) {
427 // Anonymous users are not in the database (don't need cache)
428 $this->loadDefaults();
432 // Try cache (unless this needs data from the master DB).
433 // NOTE: if this thread called saveSettings(), the cache was cleared.
434 $latest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
436 if ( !$this->loadFromDatabase( $flags ) ) {
437 // Can't load from ID
441 $this->loadFromCache();
444 $this->mLoadedItems
= true;
445 $this->queryFlagsUsed
= $flags;
452 * @param string $wikiId
453 * @param integer $userId
455 public static function purge( $wikiId, $userId ) {
456 $cache = ObjectCache
::getMainWANInstance();
457 $key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
458 $cache->delete( $key );
463 * @param WANObjectCache $cache
466 protected function getCacheKey( WANObjectCache
$cache ) {
467 return $cache->makeGlobalKey( 'user', 'id', wfWikiID(), $this->mId
);
471 * Load user data from shared cache, given mId has already been set.
476 protected function loadFromCache() {
477 $cache = ObjectCache
::getMainWANInstance();
478 $data = $cache->getWithSetCallback(
479 $this->getCacheKey( $cache ),
481 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
482 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
483 wfDebug( "User: cache miss for user {$this->mId}\n" );
485 $this->loadFromDatabase( self
::READ_NORMAL
);
487 $this->loadOptions();
490 foreach ( self
::$mCacheVars as $name ) {
491 $data[$name] = $this->$name;
494 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->mTouched
), $ttl );
499 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'version' => self
::VERSION
]
502 // Restore from cache
503 foreach ( self
::$mCacheVars as $name ) {
504 $this->$name = $data[$name];
510 /** @name newFrom*() static factory methods */
514 * Static factory method for creation from username.
516 * This is slightly less efficient than newFromId(), so use newFromId() if
517 * you have both an ID and a name handy.
519 * @param string $name Username, validated by Title::newFromText()
520 * @param string|bool $validate Validate username. Takes the same parameters as
521 * User::getCanonicalName(), except that true is accepted as an alias
522 * for 'valid', for BC.
524 * @return User|bool User object, or false if the username is invalid
525 * (e.g. if it contains illegal characters or is an IP address). If the
526 * username is not present in the database, the result will be a user object
527 * with a name, zero user ID and default settings.
529 public static function newFromName( $name, $validate = 'valid' ) {
530 if ( $validate === true ) {
533 $name = self
::getCanonicalName( $name, $validate );
534 if ( $name === false ) {
537 // Create unloaded user object
541 $u->setItemLoaded( 'name' );
547 * Static factory method for creation from a given user ID.
549 * @param int $id Valid user ID
550 * @return User The corresponding User object
552 public static function newFromId( $id ) {
556 $u->setItemLoaded( 'id' );
561 * Factory method to fetch whichever user has a given email confirmation code.
562 * This code is generated when an account is created or its e-mail address
565 * If the code is invalid or has expired, returns NULL.
567 * @param string $code Confirmation code
568 * @param int $flags User::READ_* bitfield
571 public static function newFromConfirmationCode( $code, $flags = 0 ) {
572 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
573 ?
wfGetDB( DB_MASTER
)
574 : wfGetDB( DB_REPLICA
);
576 $id = $db->selectField(
580 'user_email_token' => md5( $code ),
581 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
585 return $id ? User
::newFromId( $id ) : null;
589 * Create a new user object using data from session. If the login
590 * credentials are invalid, the result is an anonymous user.
592 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
595 public static function newFromSession( WebRequest
$request = null ) {
597 $user->mFrom
= 'session';
598 $user->mRequest
= $request;
603 * Create a new user object from a user row.
604 * The row should have the following fields from the user table in it:
605 * - either user_name or user_id to load further data if needed (or both)
607 * - all other fields (email, etc.)
608 * It is useless to provide the remaining fields if either user_id,
609 * user_name and user_real_name are not provided because the whole row
610 * will be loaded once more from the database when accessing them.
612 * @param stdClass $row A row from the user table
613 * @param array $data Further data to load into the object (see User::loadFromRow for valid keys)
616 public static function newFromRow( $row, $data = null ) {
618 $user->loadFromRow( $row, $data );
623 * Static factory method for creation of a "system" user from username.
625 * A "system" user is an account that's used to attribute logged actions
626 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
627 * might include the 'Maintenance script' or 'Conversion script' accounts
628 * used by various scripts in the maintenance/ directory or accounts such
629 * as 'MediaWiki message delivery' used by the MassMessage extension.
631 * This can optionally create the user if it doesn't exist, and "steal" the
632 * account if it does exist.
634 * "Stealing" an existing user is intended to make it impossible for normal
635 * authentication processes to use the account, effectively disabling the
636 * account for normal use:
637 * - Email is invalidated, to prevent account recovery by emailing a
638 * temporary password and to disassociate the account from the existing
640 * - The token is set to a magic invalid value, to kill existing sessions
641 * and to prevent $this->setToken() calls from resetting the token to a
643 * - SessionManager is instructed to prevent new sessions for the user, to
644 * do things like deauthorizing OAuth consumers.
645 * - AuthManager is instructed to revoke access, to invalidate or remove
646 * passwords and other credentials.
648 * @param string $name Username
649 * @param array $options Options are:
650 * - validate: As for User::getCanonicalName(), default 'valid'
651 * - create: Whether to create the user if it doesn't already exist, default true
652 * - steal: Whether to "disable" the account for normal use if it already
653 * exists, default false
657 public static function newSystemUser( $name, $options = [] ) {
659 'validate' => 'valid',
664 $name = self
::getCanonicalName( $name, $options['validate'] );
665 if ( $name === false ) {
669 $fields = self
::selectFields();
671 $dbw = wfGetDB( DB_MASTER
);
672 $row = $dbw->selectRow(
675 [ 'user_name' => $name ],
679 // No user. Create it?
680 return $options['create'] ? self
::createNew( $name, [ 'token' => self
::INVALID_TOKEN
] ) : null;
682 $user = self
::newFromRow( $row );
684 // A user is considered to exist as a non-system user if it can
685 // authenticate, or has an email set, or has a non-invalid token.
686 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
687 AuthManager
::singleton()->userCanAuthenticate( $name )
689 // User exists. Steal it?
690 if ( !$options['steal'] ) {
694 AuthManager
::singleton()->revokeAccessForUser( $name );
696 $user->invalidateEmail();
697 $user->mToken
= self
::INVALID_TOKEN
;
698 $user->saveSettings();
699 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
708 * Get the username corresponding to a given user ID
709 * @param int $id User ID
710 * @return string|bool The corresponding username
712 public static function whoIs( $id ) {
713 return UserCache
::singleton()->getProp( $id, 'name' );
717 * Get the real name of a user given their user ID
719 * @param int $id User ID
720 * @return string|bool The corresponding user's real name
722 public static function whoIsReal( $id ) {
723 return UserCache
::singleton()->getProp( $id, 'real_name' );
727 * Get database id given a user name
728 * @param string $name Username
729 * @param integer $flags User::READ_* constant bitfield
730 * @return int|null The corresponding user's ID, or null if user is nonexistent
732 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
733 $nt = Title
::makeTitleSafe( NS_USER
, $name );
734 if ( is_null( $nt ) ) {
739 if ( !( $flags & self
::READ_LATEST
) && isset( self
::$idCacheByName[$name] ) ) {
740 return self
::$idCacheByName[$name];
743 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
744 $db = wfGetDB( $index );
749 [ 'user_name' => $nt->getText() ],
754 if ( $s === false ) {
757 $result = $s->user_id
;
760 self
::$idCacheByName[$name] = $result;
762 if ( count( self
::$idCacheByName ) > 1000 ) {
763 self
::$idCacheByName = [];
770 * Reset the cache used in idFromName(). For use in tests.
772 public static function resetIdByNameCache() {
773 self
::$idCacheByName = [];
777 * Does the string match an anonymous IP address?
779 * This function exists for username validation, in order to reject
780 * usernames which are similar in form to IP addresses. Strings such
781 * as 300.300.300.300 will return true because it looks like an IP
782 * address, despite not being strictly valid.
784 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
785 * address because the usemod software would "cloak" anonymous IP
786 * addresses like this, if we allowed accounts like this to be created
787 * new users could get the old edits of these anonymous users.
789 * @param string $name Name to match
792 public static function isIP( $name ) {
793 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
794 || IP
::isIPv6( $name );
798 * Is the input a valid username?
800 * Checks if the input is a valid username, we don't want an empty string,
801 * an IP address, anything that contains slashes (would mess up subpages),
802 * is longer than the maximum allowed username size or doesn't begin with
805 * @param string $name Name to match
808 public static function isValidUserName( $name ) {
809 global $wgContLang, $wgMaxNameChars;
812 || User
::isIP( $name )
813 ||
strpos( $name, '/' ) !== false
814 ||
strlen( $name ) > $wgMaxNameChars
815 ||
$name != $wgContLang->ucfirst( $name )
820 // Ensure that the name can't be misresolved as a different title,
821 // such as with extra namespace keys at the start.
822 $parsed = Title
::newFromText( $name );
823 if ( is_null( $parsed )
824 ||
$parsed->getNamespace()
825 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
829 // Check an additional blacklist of troublemaker characters.
830 // Should these be merged into the title char list?
831 $unicodeBlacklist = '/[' .
832 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
833 '\x{00a0}' . # non-breaking space
834 '\x{2000}-\x{200f}' . # various whitespace
835 '\x{2028}-\x{202f}' . # breaks and control chars
836 '\x{3000}' . # ideographic space
837 '\x{e000}-\x{f8ff}' . # private use
839 if ( preg_match( $unicodeBlacklist, $name ) ) {
847 * Usernames which fail to pass this function will be blocked
848 * from user login and new account registrations, but may be used
849 * internally by batch processes.
851 * If an account already exists in this form, login will be blocked
852 * by a failure to pass this function.
854 * @param string $name Name to match
857 public static function isUsableName( $name ) {
858 global $wgReservedUsernames;
859 // Must be a valid username, obviously ;)
860 if ( !self
::isValidUserName( $name ) ) {
864 static $reservedUsernames = false;
865 if ( !$reservedUsernames ) {
866 $reservedUsernames = $wgReservedUsernames;
867 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
870 // Certain names may be reserved for batch processes.
871 foreach ( $reservedUsernames as $reserved ) {
872 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
873 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
875 if ( $reserved == $name ) {
883 * Return the users who are members of the given group(s). In case of multiple groups,
884 * users who are members of at least one of them are returned.
886 * @param string|array $groups A single group name or an array of group names
887 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
888 * records; larger values are ignored.
889 * @param int $after ID the user to start after
890 * @return UserArrayFromResult
892 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
893 if ( $groups === [] ) {
894 return UserArrayFromResult
::newFromIDs( [] );
897 $groups = array_unique( (array)$groups );
898 $limit = min( 5000, $limit );
900 $conds = [ 'ug_group' => $groups ];
901 if ( $after !== null ) {
902 $conds[] = 'ug_user > ' . (int)$after;
905 $dbr = wfGetDB( DB_REPLICA
);
906 $ids = $dbr->selectFieldValues(
913 'ORDER BY' => 'ug_user',
917 return UserArray
::newFromIDs( $ids );
921 * Usernames which fail to pass this function will be blocked
922 * from new account registrations, but may be used internally
923 * either by batch processes or by user accounts which have
924 * already been created.
926 * Additional blacklisting may be added here rather than in
927 * isValidUserName() to avoid disrupting existing accounts.
929 * @param string $name String to match
932 public static function isCreatableName( $name ) {
933 global $wgInvalidUsernameCharacters;
935 // Ensure that the username isn't longer than 235 bytes, so that
936 // (at least for the builtin skins) user javascript and css files
937 // will work. (bug 23080)
938 if ( strlen( $name ) > 235 ) {
939 wfDebugLog( 'username', __METHOD__
.
940 ": '$name' invalid due to length" );
944 // Preg yells if you try to give it an empty string
945 if ( $wgInvalidUsernameCharacters !== '' ) {
946 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
947 wfDebugLog( 'username', __METHOD__
.
948 ": '$name' invalid due to wgInvalidUsernameCharacters" );
953 return self
::isUsableName( $name );
957 * Is the input a valid password for this user?
959 * @param string $password Desired password
962 public function isValidPassword( $password ) {
963 // simple boolean wrapper for getPasswordValidity
964 return $this->getPasswordValidity( $password ) === true;
968 * Given unvalidated password input, return error message on failure.
970 * @param string $password Desired password
971 * @return bool|string|array True on success, string or array of error message on failure
973 public function getPasswordValidity( $password ) {
974 $result = $this->checkPasswordValidity( $password );
975 if ( $result->isGood() ) {
979 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
980 $messages[] = $error['message'];
982 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
983 $messages[] = $warning['message'];
985 if ( count( $messages ) === 1 ) {
993 * Check if this is a valid password for this user
995 * Create a Status object based on the password's validity.
996 * The Status should be set to fatal if the user should not
997 * be allowed to log in, and should have any errors that
998 * would block changing the password.
1000 * If the return value of this is not OK, the password
1001 * should not be checked. If the return value is not Good,
1002 * the password can be checked, but the user should not be
1003 * able to set their password to this.
1005 * @param string $password Desired password
1009 public function checkPasswordValidity( $password ) {
1010 global $wgPasswordPolicy;
1012 $upp = new UserPasswordPolicy(
1013 $wgPasswordPolicy['policies'],
1014 $wgPasswordPolicy['checks']
1017 $status = Status
::newGood();
1018 $result = false; // init $result to false for the internal checks
1020 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1021 $status->error( $result );
1025 if ( $result === false ) {
1026 $status->merge( $upp->checkUserPassword( $this, $password ) );
1028 } elseif ( $result === true ) {
1031 $status->error( $result );
1032 return $status; // the isValidPassword hook set a string $result and returned true
1037 * Given unvalidated user input, return a canonical username, or false if
1038 * the username is invalid.
1039 * @param string $name User input
1040 * @param string|bool $validate Type of validation to use:
1041 * - false No validation
1042 * - 'valid' Valid for batch processes
1043 * - 'usable' Valid for batch processes and login
1044 * - 'creatable' Valid for batch processes, login and account creation
1046 * @throws InvalidArgumentException
1047 * @return bool|string
1049 public static function getCanonicalName( $name, $validate = 'valid' ) {
1050 // Force usernames to capital
1052 $name = $wgContLang->ucfirst( $name );
1054 # Reject names containing '#'; these will be cleaned up
1055 # with title normalisation, but then it's too late to
1057 if ( strpos( $name, '#' ) !== false ) {
1061 // Clean up name according to title rules,
1062 // but only when validation is requested (bug 12654)
1063 $t = ( $validate !== false ) ?
1064 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1065 // Check for invalid titles
1066 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1070 // Reject various classes of invalid names
1071 $name = AuthManager
::callLegacyAuthPlugin(
1072 'getCanonicalName', [ $t->getText() ], $t->getText()
1075 switch ( $validate ) {
1079 if ( !User
::isValidUserName( $name ) ) {
1084 if ( !User
::isUsableName( $name ) ) {
1089 if ( !User
::isCreatableName( $name ) ) {
1094 throw new InvalidArgumentException(
1095 'Invalid parameter value for $validate in ' . __METHOD__
);
1101 * Return a random password.
1103 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1104 * @return string New random password
1106 public static function randomPassword() {
1107 global $wgMinimalPasswordLength;
1108 return PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1112 * Set cached properties to default.
1114 * @note This no longer clears uncached lazy-initialised properties;
1115 * the constructor does that instead.
1117 * @param string|bool $name
1119 public function loadDefaults( $name = false ) {
1121 $this->mName
= $name;
1122 $this->mRealName
= '';
1124 $this->mOptionOverrides
= null;
1125 $this->mOptionsLoaded
= false;
1127 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1128 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1129 if ( $loggedOut !== 0 ) {
1130 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1132 $this->mTouched
= '1'; # Allow any pages to be cached
1135 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1136 $this->mEmailAuthenticated
= null;
1137 $this->mEmailToken
= '';
1138 $this->mEmailTokenExpires
= null;
1139 $this->mRegistration
= wfTimestamp( TS_MW
);
1140 $this->mGroups
= [];
1142 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1146 * Return whether an item has been loaded.
1148 * @param string $item Item to check. Current possibilities:
1152 * @param string $all 'all' to check if the whole object has been loaded
1153 * or any other string to check if only the item is available (e.g.
1157 public function isItemLoaded( $item, $all = 'all' ) {
1158 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1159 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1163 * Set that an item has been loaded
1165 * @param string $item
1167 protected function setItemLoaded( $item ) {
1168 if ( is_array( $this->mLoadedItems
) ) {
1169 $this->mLoadedItems
[$item] = true;
1174 * Load user data from the session.
1176 * @return bool True if the user is logged in, false otherwise.
1178 private function loadFromSession() {
1181 Hooks
::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1182 if ( $result !== null ) {
1186 // MediaWiki\Session\Session already did the necessary authentication of the user
1187 // returned here, so just use it if applicable.
1188 $session = $this->getRequest()->getSession();
1189 $user = $session->getUser();
1190 if ( $user->isLoggedIn() ) {
1191 $this->loadFromUserObject( $user );
1193 // If this user is autoblocked, set a cookie to track the Block. This has to be done on
1194 // every session load, because an autoblocked editor might not edit again from the same
1195 // IP address after being blocked.
1196 $config = RequestContext
::getMain()->getConfig();
1197 if ( $config->get( 'CookieSetOnAutoblock' ) === true ) {
1198 $block = $this->getBlock();
1199 $shouldSetCookie = $this->getRequest()->getCookie( 'BlockID' ) === null
1201 && $block->getType() === Block
::TYPE_USER
1202 && $block->isAutoblocking();
1203 if ( $shouldSetCookie ) {
1204 wfDebug( __METHOD__
. ': User is autoblocked, setting cookie to track' );
1205 $block->setCookie( $this->getRequest()->response() );
1209 // Other code expects these to be set in the session, so set them.
1210 $session->set( 'wsUserID', $this->getId() );
1211 $session->set( 'wsUserName', $this->getName() );
1212 $session->set( 'wsToken', $this->getToken() );
1219 * Load user and user_group data from the database.
1220 * $this->mId must be set, this is how the user is identified.
1222 * @param integer $flags User::READ_* constant bitfield
1223 * @return bool True if the user exists, false if the user is anonymous
1225 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1227 $this->mId
= intval( $this->mId
);
1229 if ( !$this->mId
) {
1230 // Anonymous users are not in the database
1231 $this->loadDefaults();
1235 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1236 $db = wfGetDB( $index );
1238 $s = $db->selectRow(
1240 self
::selectFields(),
1241 [ 'user_id' => $this->mId
],
1246 $this->queryFlagsUsed
= $flags;
1247 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1249 if ( $s !== false ) {
1250 // Initialise user table data
1251 $this->loadFromRow( $s );
1252 $this->mGroups
= null; // deferred
1253 $this->getEditCount(); // revalidation for nulls
1258 $this->loadDefaults();
1264 * Initialize this object from a row from the user table.
1266 * @param stdClass $row Row from the user table to load.
1267 * @param array $data Further user data to load into the object
1269 * user_groups Array with groups out of the user_groups table
1270 * user_properties Array with properties out of the user_properties table
1272 protected function loadFromRow( $row, $data = null ) {
1275 $this->mGroups
= null; // deferred
1277 if ( isset( $row->user_name
) ) {
1278 $this->mName
= $row->user_name
;
1279 $this->mFrom
= 'name';
1280 $this->setItemLoaded( 'name' );
1285 if ( isset( $row->user_real_name
) ) {
1286 $this->mRealName
= $row->user_real_name
;
1287 $this->setItemLoaded( 'realname' );
1292 if ( isset( $row->user_id
) ) {
1293 $this->mId
= intval( $row->user_id
);
1294 $this->mFrom
= 'id';
1295 $this->setItemLoaded( 'id' );
1300 if ( isset( $row->user_id
) && isset( $row->user_name
) ) {
1301 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1304 if ( isset( $row->user_editcount
) ) {
1305 $this->mEditCount
= $row->user_editcount
;
1310 if ( isset( $row->user_touched
) ) {
1311 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1316 if ( isset( $row->user_token
) ) {
1317 // The definition for the column is binary(32), so trim the NULs
1318 // that appends. The previous definition was char(32), so trim
1320 $this->mToken
= rtrim( $row->user_token
, " \0" );
1321 if ( $this->mToken
=== '' ) {
1322 $this->mToken
= null;
1328 if ( isset( $row->user_email
) ) {
1329 $this->mEmail
= $row->user_email
;
1330 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1331 $this->mEmailToken
= $row->user_email_token
;
1332 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1333 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1339 $this->mLoadedItems
= true;
1342 if ( is_array( $data ) ) {
1343 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1344 $this->mGroups
= $data['user_groups'];
1346 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1347 $this->loadOptions( $data['user_properties'] );
1353 * Load the data for this user object from another user object.
1357 protected function loadFromUserObject( $user ) {
1359 foreach ( self
::$mCacheVars as $var ) {
1360 $this->$var = $user->$var;
1365 * Load the groups from the database if they aren't already loaded.
1367 private function loadGroups() {
1368 if ( is_null( $this->mGroups
) ) {
1369 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1370 ?
wfGetDB( DB_MASTER
)
1371 : wfGetDB( DB_REPLICA
);
1372 $res = $db->select( 'user_groups',
1374 [ 'ug_user' => $this->mId
],
1376 $this->mGroups
= [];
1377 foreach ( $res as $row ) {
1378 $this->mGroups
[] = $row->ug_group
;
1384 * Add the user to the group if he/she meets given criteria.
1386 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1387 * possible to remove manually via Special:UserRights. In such case it
1388 * will not be re-added automatically. The user will also not lose the
1389 * group if they no longer meet the criteria.
1391 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1393 * @return array Array of groups the user has been promoted to.
1395 * @see $wgAutopromoteOnce
1397 public function addAutopromoteOnceGroups( $event ) {
1398 global $wgAutopromoteOnceLogInRC;
1400 if ( wfReadOnly() ||
!$this->getId() ) {
1404 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1405 if ( !count( $toPromote ) ) {
1409 if ( !$this->checkAndSetTouched() ) {
1410 return []; // raced out (bug T48834)
1413 $oldGroups = $this->getGroups(); // previous groups
1414 foreach ( $toPromote as $group ) {
1415 $this->addGroup( $group );
1417 // update groups in external authentication database
1418 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false ] );
1419 AuthManager
::callLegacyAuthPlugin( 'updateExternalDBGroups', [ $this, $toPromote ] );
1421 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1423 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1424 $logEntry->setPerformer( $this );
1425 $logEntry->setTarget( $this->getUserPage() );
1426 $logEntry->setParameters( [
1427 '4::oldgroups' => $oldGroups,
1428 '5::newgroups' => $newGroups,
1430 $logid = $logEntry->insert();
1431 if ( $wgAutopromoteOnceLogInRC ) {
1432 $logEntry->publish( $logid );
1439 * Builds update conditions. Additional conditions may be added to $conditions to
1440 * protected against race conditions using a compare-and-set (CAS) mechanism
1441 * based on comparing $this->mTouched with the user_touched field.
1443 * @param Database $db
1444 * @param array $conditions WHERE conditions for use with Database::update
1445 * @return array WHERE conditions for use with Database::update
1447 protected function makeUpdateConditions( Database
$db, array $conditions ) {
1448 if ( $this->mTouched
) {
1449 // CAS check: only update if the row wasn't changed sicne it was loaded.
1450 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1457 * Bump user_touched if it didn't change since this object was loaded
1459 * On success, the mTouched field is updated.
1460 * The user serialization cache is always cleared.
1462 * @return bool Whether user_touched was actually updated
1465 protected function checkAndSetTouched() {
1468 if ( !$this->mId
) {
1469 return false; // anon
1472 // Get a new user_touched that is higher than the old one
1473 $newTouched = $this->newTouchedTimestamp();
1475 $dbw = wfGetDB( DB_MASTER
);
1476 $dbw->update( 'user',
1477 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1478 $this->makeUpdateConditions( $dbw, [
1479 'user_id' => $this->mId
,
1483 $success = ( $dbw->affectedRows() > 0 );
1486 $this->mTouched
= $newTouched;
1487 $this->clearSharedCache();
1489 // Clears on failure too since that is desired if the cache is stale
1490 $this->clearSharedCache( 'refresh' );
1497 * Clear various cached data stored in this object. The cache of the user table
1498 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1500 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1501 * given source. May be "name", "id", "defaults", "session", or false for no reload.
1503 public function clearInstanceCache( $reloadFrom = false ) {
1504 $this->mNewtalk
= -1;
1505 $this->mDatePreference
= null;
1506 $this->mBlockedby
= -1; # Unset
1507 $this->mHash
= false;
1508 $this->mRights
= null;
1509 $this->mEffectiveGroups
= null;
1510 $this->mImplicitGroups
= null;
1511 $this->mGroups
= null;
1512 $this->mOptions
= null;
1513 $this->mOptionsLoaded
= false;
1514 $this->mEditCount
= null;
1516 if ( $reloadFrom ) {
1517 $this->mLoadedItems
= [];
1518 $this->mFrom
= $reloadFrom;
1523 * Combine the language default options with any site-specific options
1524 * and add the default language variants.
1526 * @return array Array of String options
1528 public static function getDefaultOptions() {
1529 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1531 static $defOpt = null;
1532 static $defOptLang = null;
1534 if ( $defOpt !== null && $defOptLang === $wgContLang->getCode() ) {
1535 // $wgContLang does not change (and should not change) mid-request,
1536 // but the unit tests change it anyway, and expect this method to
1537 // return values relevant to the current $wgContLang.
1541 $defOpt = $wgDefaultUserOptions;
1542 // Default language setting
1543 $defOptLang = $wgContLang->getCode();
1544 $defOpt['language'] = $defOptLang;
1545 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1546 $defOpt[$langCode == $wgContLang->getCode() ?
'variant' : "variant-$langCode"] = $langCode;
1549 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1550 // since extensions may change the set of searchable namespaces depending
1551 // on user groups/permissions.
1552 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1553 $defOpt['searchNs' . $nsnum] = (boolean
)$val;
1555 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1557 Hooks
::run( 'UserGetDefaultOptions', [ &$defOpt ] );
1563 * Get a given default option value.
1565 * @param string $opt Name of option to retrieve
1566 * @return string Default option value
1568 public static function getDefaultOption( $opt ) {
1569 $defOpts = self
::getDefaultOptions();
1570 if ( isset( $defOpts[$opt] ) ) {
1571 return $defOpts[$opt];
1578 * Get blocking information
1579 * @param bool $bFromSlave Whether to check the replica DB first.
1580 * To improve performance, non-critical checks are done against replica DBs.
1581 * Check when actually saving should be done against master.
1583 private function getBlockedStatus( $bFromSlave = true ) {
1584 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff;
1586 if ( -1 != $this->mBlockedby
) {
1590 wfDebug( __METHOD__
. ": checking...\n" );
1592 // Initialize data...
1593 // Otherwise something ends up stomping on $this->mBlockedby when
1594 // things get lazy-loaded later, causing false positive block hits
1595 // due to -1 !== 0. Probably session-related... Nothing should be
1596 // overwriting mBlockedby, surely?
1599 # We only need to worry about passing the IP address to the Block generator if the
1600 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1601 # know which IP address they're actually coming from
1603 if ( !$this->isAllowed( 'ipblock-exempt' ) ) {
1604 // $wgUser->getName() only works after the end of Setup.php. Until
1605 // then, assume it's a logged-out user.
1606 $globalUserName = $wgUser->isSafeToLoad()
1607 ?
$wgUser->getName()
1608 : IP
::sanitizeIP( $wgUser->getRequest()->getIP() );
1609 if ( $this->getName() === $globalUserName ) {
1610 $ip = $this->getRequest()->getIP();
1615 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1617 // If no block has been found, check for a cookie indicating that the user is blocked.
1618 $blockCookieVal = (int)$this->getRequest()->getCookie( 'BlockID' );
1619 if ( !$block instanceof Block
&& $blockCookieVal > 0 ) {
1620 // Load the Block from the ID in the cookie.
1621 $tmpBlock = Block
::newFromID( $blockCookieVal );
1622 if ( $tmpBlock instanceof Block
) {
1623 // Check the validity of the block.
1624 $blockIsValid = $tmpBlock->getType() == Block
::TYPE_USER
1625 && !$tmpBlock->isExpired()
1626 && $tmpBlock->isAutoblocking();
1627 $config = RequestContext
::getMain()->getConfig();
1628 $useBlockCookie = ( $config->get( 'CookieSetOnAutoblock' ) === true );
1629 if ( $blockIsValid && $useBlockCookie ) {
1632 $this->blockTrigger
= 'cookie-block';
1634 // If the block is not valid, clear the block cookie (but don't delete it,
1635 // because it needs to be cleared from LocalStorage as well and an empty string
1636 // value is checked for in the mediawiki.user.blockcookie module).
1637 $tmpBlock->setCookie( $this->getRequest()->response(), true );
1643 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1645 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1646 $block = new Block( [
1647 'byText' => wfMessage( 'proxyblocker' )->text(),
1648 'reason' => wfMessage( 'proxyblockreason' )->text(),
1650 'systemBlock' => 'proxy',
1652 $this->blockTrigger
= 'proxy-block';
1653 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1654 $block = new Block( [
1655 'byText' => wfMessage( 'sorbs' )->text(),
1656 'reason' => wfMessage( 'sorbsreason' )->text(),
1658 'systemBlock' => 'dnsbl',
1660 $this->blockTrigger
= 'openproxy-block';
1664 // (bug 23343) Apply IP blocks to the contents of XFF headers, if enabled
1665 if ( !$block instanceof Block
1666 && $wgApplyIpBlocksToXff
1668 && !in_array( $ip, $wgProxyWhitelist )
1670 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1671 $xff = array_map( 'trim', explode( ',', $xff ) );
1672 $xff = array_diff( $xff, [ $ip ] );
1673 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1674 $block = Block
::chooseBlock( $xffblocks, $xff );
1675 if ( $block instanceof Block
) {
1676 # Mangle the reason to alert the user that the block
1677 # originated from matching the X-Forwarded-For header.
1678 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->text();
1679 $this->blockTrigger
= 'xff-block';
1683 if ( $block instanceof Block
) {
1684 wfDebug( __METHOD__
. ": Found block.\n" );
1685 $this->mBlock
= $block;
1686 $this->mBlockedby
= $block->getByName();
1687 $this->mBlockreason
= $block->mReason
;
1688 $this->mHideName
= $block->mHideName
;
1689 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1691 $this->mBlockedby
= '';
1692 $this->mHideName
= 0;
1693 $this->mAllowUsertalk
= false;
1694 $this->blockTrigger
= false;
1698 Hooks
::run( 'GetBlockedStatus', [ &$this ] );
1702 * Whether the given IP is in a DNS blacklist.
1704 * @param string $ip IP to check
1705 * @param bool $checkWhitelist Whether to check the whitelist first
1706 * @return bool True if blacklisted.
1708 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1709 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1711 if ( !$wgEnableDnsBlacklist ) {
1715 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1719 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
1723 * Whether the given IP is in a given DNS blacklist.
1725 * @param string $ip IP to check
1726 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1727 * @return bool True if blacklisted.
1729 public function inDnsBlacklist( $ip, $bases ) {
1731 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
1732 if ( IP
::isIPv4( $ip ) ) {
1733 // Reverse IP, bug 21255
1734 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1736 foreach ( (array)$bases as $base ) {
1738 // If we have an access key, use that too (ProjectHoneypot, etc.)
1740 if ( is_array( $base ) ) {
1741 if ( count( $base ) >= 2 ) {
1742 // Access key is 1, base URL is 0
1743 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1745 $host = "$ipReversed.{$base[0]}";
1747 $basename = $base[0];
1749 $host = "$ipReversed.$base";
1753 $ipList = gethostbynamel( $host );
1756 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
1760 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
1769 * Check if an IP address is in the local proxy list
1775 public static function isLocallyBlockedProxy( $ip ) {
1776 global $wgProxyList;
1778 if ( !$wgProxyList ) {
1782 if ( !is_array( $wgProxyList ) ) {
1783 // Load from the specified file
1784 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1787 if ( !is_array( $wgProxyList ) ) {
1789 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1791 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1792 // Old-style flipped proxy list
1801 * Is this user subject to rate limiting?
1803 * @return bool True if rate limited
1805 public function isPingLimitable() {
1806 global $wgRateLimitsExcludedIPs;
1807 if ( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1808 // No other good way currently to disable rate limits
1809 // for specific IPs. :P
1810 // But this is a crappy hack and should die.
1813 return !$this->isAllowed( 'noratelimit' );
1817 * Primitive rate limits: enforce maximum actions per time period
1818 * to put a brake on flooding.
1820 * The method generates both a generic profiling point and a per action one
1821 * (suffix being "-$action".
1823 * @note When using a shared cache like memcached, IP-address
1824 * last-hit counters will be shared across wikis.
1826 * @param string $action Action to enforce; 'edit' if unspecified
1827 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1828 * @return bool True if a rate limiter was tripped
1830 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1831 // Call the 'PingLimiter' hook
1833 if ( !Hooks
::run( 'PingLimiter', [ &$this, $action, &$result, $incrBy ] ) ) {
1837 global $wgRateLimits;
1838 if ( !isset( $wgRateLimits[$action] ) ) {
1842 $limits = array_merge(
1843 [ '&can-bypass' => true ],
1844 $wgRateLimits[$action]
1847 // Some groups shouldn't trigger the ping limiter, ever
1848 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
1853 $id = $this->getId();
1855 $isNewbie = $this->isNewbie();
1859 if ( isset( $limits['anon'] ) ) {
1860 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1863 // limits for logged-in users
1864 if ( isset( $limits['user'] ) ) {
1865 $userLimit = $limits['user'];
1867 // limits for newbie logged-in users
1868 if ( $isNewbie && isset( $limits['newbie'] ) ) {
1869 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1873 // limits for anons and for newbie logged-in users
1876 if ( isset( $limits['ip'] ) ) {
1877 $ip = $this->getRequest()->getIP();
1878 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1880 // subnet-based limits
1881 if ( isset( $limits['subnet'] ) ) {
1882 $ip = $this->getRequest()->getIP();
1883 $subnet = IP
::getSubnet( $ip );
1884 if ( $subnet !== false ) {
1885 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1890 // Check for group-specific permissions
1891 // If more than one group applies, use the group with the highest limit ratio (max/period)
1892 foreach ( $this->getGroups() as $group ) {
1893 if ( isset( $limits[$group] ) ) {
1894 if ( $userLimit === false
1895 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
1897 $userLimit = $limits[$group];
1902 // Set the user limit key
1903 if ( $userLimit !== false ) {
1904 list( $max, $period ) = $userLimit;
1905 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
1906 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $userLimit;
1909 // ip-based limits for all ping-limitable users
1910 if ( isset( $limits['ip-all'] ) ) {
1911 $ip = $this->getRequest()->getIP();
1912 // ignore if user limit is more permissive
1913 if ( $isNewbie ||
$userLimit === false
1914 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
1915 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
1919 // subnet-based limits for all ping-limitable users
1920 if ( isset( $limits['subnet-all'] ) ) {
1921 $ip = $this->getRequest()->getIP();
1922 $subnet = IP
::getSubnet( $ip );
1923 if ( $subnet !== false ) {
1924 // ignore if user limit is more permissive
1925 if ( $isNewbie ||
$userLimit === false
1926 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
1927 > $userLimit[0] / $userLimit[1] ) {
1928 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
1933 $cache = ObjectCache
::getLocalClusterInstance();
1936 foreach ( $keys as $key => $limit ) {
1937 list( $max, $period ) = $limit;
1938 $summary = "(limit $max in {$period}s)";
1939 $count = $cache->get( $key );
1942 if ( $count >= $max ) {
1943 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
1944 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
1947 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1950 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1951 if ( $incrBy > 0 ) {
1952 $cache->add( $key, 0, intval( $period ) ); // first ping
1955 if ( $incrBy > 0 ) {
1956 $cache->incr( $key, $incrBy );
1964 * Check if user is blocked
1966 * @param bool $bFromSlave Whether to check the replica DB instead of
1967 * the master. Hacked from false due to horrible probs on site.
1968 * @return bool True if blocked, false otherwise
1970 public function isBlocked( $bFromSlave = true ) {
1971 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1975 * Get the block affecting the user, or null if the user is not blocked
1977 * @param bool $bFromSlave Whether to check the replica DB instead of the master
1978 * @return Block|null
1980 public function getBlock( $bFromSlave = true ) {
1981 $this->getBlockedStatus( $bFromSlave );
1982 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1986 * Check if user is blocked from editing a particular article
1988 * @param Title $title Title to check
1989 * @param bool $bFromSlave Whether to check the replica DB instead of the master
1992 public function isBlockedFrom( $title, $bFromSlave = false ) {
1993 global $wgBlockAllowsUTEdit;
1995 $blocked = $this->isBlocked( $bFromSlave );
1996 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1997 // If a user's name is suppressed, they cannot make edits anywhere
1998 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName()
1999 && $title->getNamespace() == NS_USER_TALK
) {
2001 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
2004 Hooks
::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
2010 * If user is blocked, return the name of the user who placed the block
2011 * @return string Name of blocker
2013 public function blockedBy() {
2014 $this->getBlockedStatus();
2015 return $this->mBlockedby
;
2019 * If user is blocked, return the specified reason for the block
2020 * @return string Blocking reason
2022 public function blockedFor() {
2023 $this->getBlockedStatus();
2024 return $this->mBlockreason
;
2028 * If user is blocked, return the ID for the block
2029 * @return int Block ID
2031 public function getBlockId() {
2032 $this->getBlockedStatus();
2033 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2037 * Check if user is blocked on all wikis.
2038 * Do not use for actual edit permission checks!
2039 * This is intended for quick UI checks.
2041 * @param string $ip IP address, uses current client if none given
2042 * @return bool True if blocked, false otherwise
2044 public function isBlockedGlobally( $ip = '' ) {
2045 return $this->getGlobalBlock( $ip ) instanceof Block
;
2049 * Check if user is blocked on all wikis.
2050 * Do not use for actual edit permission checks!
2051 * This is intended for quick UI checks.
2053 * @param string $ip IP address, uses current client if none given
2054 * @return Block|null Block object if blocked, null otherwise
2055 * @throws FatalError
2056 * @throws MWException
2058 public function getGlobalBlock( $ip = '' ) {
2059 if ( $this->mGlobalBlock
!== null ) {
2060 return $this->mGlobalBlock ?
: null;
2062 // User is already an IP?
2063 if ( IP
::isIPAddress( $this->getName() ) ) {
2064 $ip = $this->getName();
2066 $ip = $this->getRequest()->getIP();
2070 Hooks
::run( 'UserIsBlockedGlobally', [ &$this, $ip, &$blocked, &$block ] );
2072 if ( $blocked && $block === null ) {
2073 // back-compat: UserIsBlockedGlobally didn't have $block param first
2074 $block = new Block( [
2076 'systemBlock' => 'global-block'
2080 $this->mGlobalBlock
= $blocked ?
$block : false;
2081 return $this->mGlobalBlock ?
: null;
2085 * Check if user account is locked
2087 * @return bool True if locked, false otherwise
2089 public function isLocked() {
2090 if ( $this->mLocked
!== null ) {
2091 return $this->mLocked
;
2093 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$this ], null );
2094 $this->mLocked
= $authUser && $authUser->isLocked();
2095 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2096 return $this->mLocked
;
2100 * Check if user account is hidden
2102 * @return bool True if hidden, false otherwise
2104 public function isHidden() {
2105 if ( $this->mHideName
!== null ) {
2106 return $this->mHideName
;
2108 $this->getBlockedStatus();
2109 if ( !$this->mHideName
) {
2110 $authUser = AuthManager
::callLegacyAuthPlugin( 'getUserInstance', [ &$this ], null );
2111 $this->mHideName
= $authUser && $authUser->isHidden();
2112 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2114 return $this->mHideName
;
2118 * Get the user's ID.
2119 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2121 public function getId() {
2122 if ( $this->mId
=== null && $this->mName
!== null && User
::isIP( $this->mName
) ) {
2123 // Special case, we know the user is anonymous
2125 } elseif ( !$this->isItemLoaded( 'id' ) ) {
2126 // Don't load if this was initialized from an ID
2130 return (int)$this->mId
;
2134 * Set the user and reload all fields according to a given ID
2135 * @param int $v User ID to reload
2137 public function setId( $v ) {
2139 $this->clearInstanceCache( 'id' );
2143 * Get the user name, or the IP of an anonymous user
2144 * @return string User's name or IP address
2146 public function getName() {
2147 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2148 // Special case optimisation
2149 return $this->mName
;
2152 if ( $this->mName
=== false ) {
2154 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2156 return $this->mName
;
2161 * Set the user name.
2163 * This does not reload fields from the database according to the given
2164 * name. Rather, it is used to create a temporary "nonexistent user" for
2165 * later addition to the database. It can also be used to set the IP
2166 * address for an anonymous user to something other than the current
2169 * @note User::newFromName() has roughly the same function, when the named user
2171 * @param string $str New user name to set
2173 public function setName( $str ) {
2175 $this->mName
= $str;
2179 * Get the user's name escaped by underscores.
2180 * @return string Username escaped by underscores.
2182 public function getTitleKey() {
2183 return str_replace( ' ', '_', $this->getName() );
2187 * Check if the user has new messages.
2188 * @return bool True if the user has new messages
2190 public function getNewtalk() {
2193 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2194 if ( $this->mNewtalk
=== -1 ) {
2195 $this->mNewtalk
= false; # reset talk page status
2197 // Check memcached separately for anons, who have no
2198 // entire User object stored in there.
2199 if ( !$this->mId
) {
2200 global $wgDisableAnonTalk;
2201 if ( $wgDisableAnonTalk ) {
2202 // Anon newtalk disabled by configuration.
2203 $this->mNewtalk
= false;
2205 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2208 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2212 return (bool)$this->mNewtalk
;
2216 * Return the data needed to construct links for new talk page message
2217 * alerts. If there are new messages, this will return an associative array
2218 * with the following data:
2219 * wiki: The database name of the wiki
2220 * link: Root-relative link to the user's talk page
2221 * rev: The last talk page revision that the user has seen or null. This
2222 * is useful for building diff links.
2223 * If there are no new messages, it returns an empty array.
2224 * @note This function was designed to accomodate multiple talk pages, but
2225 * currently only returns a single link and revision.
2228 public function getNewMessageLinks() {
2230 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$this, &$talks ] ) ) {
2232 } elseif ( !$this->getNewtalk() ) {
2235 $utp = $this->getTalkPage();
2236 $dbr = wfGetDB( DB_REPLICA
);
2237 // Get the "last viewed rev" timestamp from the oldest message notification
2238 $timestamp = $dbr->selectField( 'user_newtalk',
2239 'MIN(user_last_timestamp)',
2240 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2242 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2243 return [ [ 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ] ];
2247 * Get the revision ID for the last talk page revision viewed by the talk
2249 * @return int|null Revision ID or null
2251 public function getNewMessageRevisionId() {
2252 $newMessageRevisionId = null;
2253 $newMessageLinks = $this->getNewMessageLinks();
2254 if ( $newMessageLinks ) {
2255 // Note: getNewMessageLinks() never returns more than a single link
2256 // and it is always for the same wiki, but we double-check here in
2257 // case that changes some time in the future.
2258 if ( count( $newMessageLinks ) === 1
2259 && $newMessageLinks[0]['wiki'] === wfWikiID()
2260 && $newMessageLinks[0]['rev']
2262 /** @var Revision $newMessageRevision */
2263 $newMessageRevision = $newMessageLinks[0]['rev'];
2264 $newMessageRevisionId = $newMessageRevision->getId();
2267 return $newMessageRevisionId;
2271 * Internal uncached check for new messages
2274 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2275 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2276 * @return bool True if the user has new messages
2278 protected function checkNewtalk( $field, $id ) {
2279 $dbr = wfGetDB( DB_REPLICA
);
2281 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2283 return $ok !== false;
2287 * Add or update the new messages flag
2288 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2289 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2290 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2291 * @return bool True if successful, false otherwise
2293 protected function updateNewtalk( $field, $id, $curRev = null ) {
2294 // Get timestamp of the talk page revision prior to the current one
2295 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2296 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2297 // Mark the user as having new messages since this revision
2298 $dbw = wfGetDB( DB_MASTER
);
2299 $dbw->insert( 'user_newtalk',
2300 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2303 if ( $dbw->affectedRows() ) {
2304 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2307 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2313 * Clear the new messages flag for the given user
2314 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2315 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2316 * @return bool True if successful, false otherwise
2318 protected function deleteNewtalk( $field, $id ) {
2319 $dbw = wfGetDB( DB_MASTER
);
2320 $dbw->delete( 'user_newtalk',
2323 if ( $dbw->affectedRows() ) {
2324 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2327 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2333 * Update the 'You have new messages!' status.
2334 * @param bool $val Whether the user has new messages
2335 * @param Revision $curRev New, as yet unseen revision of the user talk
2336 * page. Ignored if null or !$val.
2338 public function setNewtalk( $val, $curRev = null ) {
2339 if ( wfReadOnly() ) {
2344 $this->mNewtalk
= $val;
2346 if ( $this->isAnon() ) {
2348 $id = $this->getName();
2351 $id = $this->getId();
2355 $changed = $this->updateNewtalk( $field, $id, $curRev );
2357 $changed = $this->deleteNewtalk( $field, $id );
2361 $this->invalidateCache();
2366 * Generate a current or new-future timestamp to be stored in the
2367 * user_touched field when we update things.
2368 * @return string Timestamp in TS_MW format
2370 private function newTouchedTimestamp() {
2371 global $wgClockSkewFudge;
2373 $time = wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2374 if ( $this->mTouched
&& $time <= $this->mTouched
) {
2375 $time = wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2382 * Clear user data from memcached
2384 * Use after applying updates to the database; caller's
2385 * responsibility to update user_touched if appropriate.
2387 * Called implicitly from invalidateCache() and saveSettings().
2389 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2391 public function clearSharedCache( $mode = 'changed' ) {
2392 if ( !$this->getId() ) {
2396 $cache = ObjectCache
::getMainWANInstance();
2397 $key = $this->getCacheKey( $cache );
2398 if ( $mode === 'refresh' ) {
2399 $cache->delete( $key, 1 );
2401 wfGetDB( DB_MASTER
)->onTransactionPreCommitOrIdle(
2402 function() use ( $cache, $key ) {
2403 $cache->delete( $key );
2411 * Immediately touch the user data cache for this account
2413 * Calls touch() and removes account data from memcached
2415 public function invalidateCache() {
2417 $this->clearSharedCache();
2421 * Update the "touched" timestamp for the user
2423 * This is useful on various login/logout events when making sure that
2424 * a browser or proxy that has multiple tenants does not suffer cache
2425 * pollution where the new user sees the old users content. The value
2426 * of getTouched() is checked when determining 304 vs 200 responses.
2427 * Unlike invalidateCache(), this preserves the User object cache and
2428 * avoids database writes.
2432 public function touch() {
2433 $id = $this->getId();
2435 $key = wfMemcKey( 'user-quicktouched', 'id', $id );
2436 ObjectCache
::getMainWANInstance()->touchCheckKey( $key );
2437 $this->mQuickTouched
= null;
2442 * Validate the cache for this account.
2443 * @param string $timestamp A timestamp in TS_MW format
2446 public function validateCache( $timestamp ) {
2447 return ( $timestamp >= $this->getTouched() );
2451 * Get the user touched timestamp
2453 * Use this value only to validate caches via inequalities
2454 * such as in the case of HTTP If-Modified-Since response logic
2456 * @return string TS_MW Timestamp
2458 public function getTouched() {
2462 if ( $this->mQuickTouched
=== null ) {
2463 $key = wfMemcKey( 'user-quicktouched', 'id', $this->mId
);
2464 $cache = ObjectCache
::getMainWANInstance();
2466 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2469 return max( $this->mTouched
, $this->mQuickTouched
);
2472 return $this->mTouched
;
2476 * Get the user_touched timestamp field (time of last DB updates)
2477 * @return string TS_MW Timestamp
2480 public function getDBTouched() {
2483 return $this->mTouched
;
2487 * Set the password and reset the random token.
2488 * Calls through to authentication plugin if necessary;
2489 * will have no effect if the auth plugin refuses to
2490 * pass the change through or if the legal password
2493 * As a special case, setting the password to null
2494 * wipes it, so the account cannot be logged in until
2495 * a new password is set, for instance via e-mail.
2497 * @deprecated since 1.27, use AuthManager instead
2498 * @param string $str New password to set
2499 * @throws PasswordError On failure
2502 public function setPassword( $str ) {
2503 return $this->setPasswordInternal( $str );
2507 * Set the password and reset the random token unconditionally.
2509 * @deprecated since 1.27, use AuthManager instead
2510 * @param string|null $str New password to set or null to set an invalid
2511 * password hash meaning that the user will not be able to log in
2512 * through the web interface.
2514 public function setInternalPassword( $str ) {
2515 $this->setPasswordInternal( $str );
2519 * Actually set the password and such
2520 * @since 1.27 cannot set a password for a user not in the database
2521 * @param string|null $str New password to set or null to set an invalid
2522 * password hash meaning that the user will not be able to log in
2523 * through the web interface.
2524 * @return bool Success
2526 private function setPasswordInternal( $str ) {
2527 $manager = AuthManager
::singleton();
2529 // If the user doesn't exist yet, fail
2530 if ( !$manager->userExists( $this->getName() ) ) {
2531 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2534 $status = $this->changeAuthenticationData( [
2535 'username' => $this->getName(),
2539 if ( !$status->isGood() ) {
2540 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2541 ->info( __METHOD__
. ': Password change rejected: '
2542 . $status->getWikiText( null, null, 'en' ) );
2546 $this->setOption( 'watchlisttoken', false );
2547 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2553 * Changes credentials of the user.
2555 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2556 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2557 * e.g. when no provider handled the change.
2559 * @param array $data A set of authentication data in fieldname => value format. This is the
2560 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2564 public function changeAuthenticationData( array $data ) {
2565 $manager = AuthManager
::singleton();
2566 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2567 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2569 $status = Status
::newGood( 'ignored' );
2570 foreach ( $reqs as $req ) {
2571 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2573 if ( $status->getValue() === 'ignored' ) {
2574 $status->warning( 'authenticationdatachange-ignored' );
2577 if ( $status->isGood() ) {
2578 foreach ( $reqs as $req ) {
2579 $manager->changeAuthenticationData( $req );
2586 * Get the user's current token.
2587 * @param bool $forceCreation Force the generation of a new token if the
2588 * user doesn't have one (default=true for backwards compatibility).
2589 * @return string|null Token
2591 public function getToken( $forceCreation = true ) {
2592 global $wgAuthenticationTokenVersion;
2595 if ( !$this->mToken
&& $forceCreation ) {
2599 if ( !$this->mToken
) {
2600 // The user doesn't have a token, return null to indicate that.
2602 } elseif ( $this->mToken
=== self
::INVALID_TOKEN
) {
2603 // We return a random value here so existing token checks are very
2605 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2606 } elseif ( $wgAuthenticationTokenVersion === null ) {
2607 // $wgAuthenticationTokenVersion not in use, so return the raw secret
2608 return $this->mToken
;
2610 // $wgAuthenticationTokenVersion in use, so hmac it.
2611 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
2613 // The raw hash can be overly long. Shorten it up.
2614 $len = max( 32, self
::TOKEN_LENGTH
);
2615 if ( strlen( $ret ) < $len ) {
2616 // Should never happen, even md5 is 128 bits
2617 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
2619 return substr( $ret, -$len );
2624 * Set the random token (used for persistent authentication)
2625 * Called from loadDefaults() among other places.
2627 * @param string|bool $token If specified, set the token to this value
2629 public function setToken( $token = false ) {
2631 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
2632 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
2633 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
2634 } elseif ( !$token ) {
2635 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2637 $this->mToken
= $token;
2642 * Set the password for a password reminder or new account email
2644 * @deprecated Removed in 1.27. Use PasswordReset instead.
2645 * @param string $str New password to set or null to set an invalid
2646 * password hash meaning that the user will not be able to use it
2647 * @param bool $throttle If true, reset the throttle timestamp to the present
2649 public function setNewpassword( $str, $throttle = true ) {
2650 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2654 * Get the user's e-mail address
2655 * @return string User's email address
2657 public function getEmail() {
2659 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
2660 return $this->mEmail
;
2664 * Get the timestamp of the user's e-mail authentication
2665 * @return string TS_MW timestamp
2667 public function getEmailAuthenticationTimestamp() {
2669 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
2670 return $this->mEmailAuthenticated
;
2674 * Set the user's e-mail address
2675 * @param string $str New e-mail address
2677 public function setEmail( $str ) {
2679 if ( $str == $this->mEmail
) {
2682 $this->invalidateEmail();
2683 $this->mEmail
= $str;
2684 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
2688 * Set the user's e-mail address and a confirmation mail if needed.
2691 * @param string $str New e-mail address
2694 public function setEmailWithConfirmation( $str ) {
2695 global $wgEnableEmail, $wgEmailAuthentication;
2697 if ( !$wgEnableEmail ) {
2698 return Status
::newFatal( 'emaildisabled' );
2701 $oldaddr = $this->getEmail();
2702 if ( $str === $oldaddr ) {
2703 return Status
::newGood( true );
2706 $type = $oldaddr != '' ?
'changed' : 'set';
2707 $notificationResult = null;
2709 if ( $wgEmailAuthentication ) {
2710 // Send the user an email notifying the user of the change in registered
2711 // email address on their previous email address
2712 if ( $type == 'changed' ) {
2713 $change = $str != '' ?
'changed' : 'removed';
2714 $notificationResult = $this->sendMail(
2715 wfMessage( 'notificationemail_subject_' . $change )->text(),
2716 wfMessage( 'notificationemail_body_' . $change,
2717 $this->getRequest()->getIP(),
2724 $this->setEmail( $str );
2726 if ( $str !== '' && $wgEmailAuthentication ) {
2727 // Send a confirmation request to the new address if needed
2728 $result = $this->sendConfirmationMail( $type );
2730 if ( $notificationResult !== null ) {
2731 $result->merge( $notificationResult );
2734 if ( $result->isGood() ) {
2735 // Say to the caller that a confirmation and notification mail has been sent
2736 $result->value
= 'eauth';
2739 $result = Status
::newGood( true );
2746 * Get the user's real name
2747 * @return string User's real name
2749 public function getRealName() {
2750 if ( !$this->isItemLoaded( 'realname' ) ) {
2754 return $this->mRealName
;
2758 * Set the user's real name
2759 * @param string $str New real name
2761 public function setRealName( $str ) {
2763 $this->mRealName
= $str;
2767 * Get the user's current setting for a given option.
2769 * @param string $oname The option to check
2770 * @param string $defaultOverride A default value returned if the option does not exist
2771 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2772 * @return string|null User's current value for the option
2773 * @see getBoolOption()
2774 * @see getIntOption()
2776 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2777 global $wgHiddenPrefs;
2778 $this->loadOptions();
2780 # We want 'disabled' preferences to always behave as the default value for
2781 # users, even if they have set the option explicitly in their settings (ie they
2782 # set it, and then it was disabled removing their ability to change it). But
2783 # we don't want to erase the preferences in the database in case the preference
2784 # is re-enabled again. So don't touch $mOptions, just override the returned value
2785 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2786 return self
::getDefaultOption( $oname );
2789 if ( array_key_exists( $oname, $this->mOptions
) ) {
2790 return $this->mOptions
[$oname];
2792 return $defaultOverride;
2797 * Get all user's options
2799 * @param int $flags Bitwise combination of:
2800 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
2801 * to the default value. (Since 1.25)
2804 public function getOptions( $flags = 0 ) {
2805 global $wgHiddenPrefs;
2806 $this->loadOptions();
2807 $options = $this->mOptions
;
2809 # We want 'disabled' preferences to always behave as the default value for
2810 # users, even if they have set the option explicitly in their settings (ie they
2811 # set it, and then it was disabled removing their ability to change it). But
2812 # we don't want to erase the preferences in the database in case the preference
2813 # is re-enabled again. So don't touch $mOptions, just override the returned value
2814 foreach ( $wgHiddenPrefs as $pref ) {
2815 $default = self
::getDefaultOption( $pref );
2816 if ( $default !== null ) {
2817 $options[$pref] = $default;
2821 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
2822 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
2829 * Get the user's current setting for a given option, as a boolean value.
2831 * @param string $oname The option to check
2832 * @return bool User's current value for the option
2835 public function getBoolOption( $oname ) {
2836 return (bool)$this->getOption( $oname );
2840 * Get the user's current setting for a given option, as an integer value.
2842 * @param string $oname The option to check
2843 * @param int $defaultOverride A default value returned if the option does not exist
2844 * @return int User's current value for the option
2847 public function getIntOption( $oname, $defaultOverride = 0 ) {
2848 $val = $this->getOption( $oname );
2850 $val = $defaultOverride;
2852 return intval( $val );
2856 * Set the given option for a user.
2858 * You need to call saveSettings() to actually write to the database.
2860 * @param string $oname The option to set
2861 * @param mixed $val New value to set
2863 public function setOption( $oname, $val ) {
2864 $this->loadOptions();
2866 // Explicitly NULL values should refer to defaults
2867 if ( is_null( $val ) ) {
2868 $val = self
::getDefaultOption( $oname );
2871 $this->mOptions
[$oname] = $val;
2875 * Get a token stored in the preferences (like the watchlist one),
2876 * resetting it if it's empty (and saving changes).
2878 * @param string $oname The option name to retrieve the token from
2879 * @return string|bool User's current value for the option, or false if this option is disabled.
2880 * @see resetTokenFromOption()
2882 * @deprecated since 1.26 Applications should use the OAuth extension
2884 public function getTokenFromOption( $oname ) {
2885 global $wgHiddenPrefs;
2887 $id = $this->getId();
2888 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
2892 $token = $this->getOption( $oname );
2894 // Default to a value based on the user token to avoid space
2895 // wasted on storing tokens for all users. When this option
2896 // is set manually by the user, only then is it stored.
2897 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
2904 * Reset a token stored in the preferences (like the watchlist one).
2905 * *Does not* save user's preferences (similarly to setOption()).
2907 * @param string $oname The option name to reset the token in
2908 * @return string|bool New token value, or false if this option is disabled.
2909 * @see getTokenFromOption()
2912 public function resetTokenFromOption( $oname ) {
2913 global $wgHiddenPrefs;
2914 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2918 $token = MWCryptRand
::generateHex( 40 );
2919 $this->setOption( $oname, $token );
2924 * Return a list of the types of user options currently returned by
2925 * User::getOptionKinds().
2927 * Currently, the option kinds are:
2928 * - 'registered' - preferences which are registered in core MediaWiki or
2929 * by extensions using the UserGetDefaultOptions hook.
2930 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2931 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
2932 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2933 * be used by user scripts.
2934 * - 'special' - "preferences" that are not accessible via User::getOptions
2935 * or User::setOptions.
2936 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2937 * These are usually legacy options, removed in newer versions.
2939 * The API (and possibly others) use this function to determine the possible
2940 * option types for validation purposes, so make sure to update this when a
2941 * new option kind is added.
2943 * @see User::getOptionKinds
2944 * @return array Option kinds
2946 public static function listOptionKinds() {
2949 'registered-multiselect',
2950 'registered-checkmatrix',
2958 * Return an associative array mapping preferences keys to the kind of a preference they're
2959 * used for. Different kinds are handled differently when setting or reading preferences.
2961 * See User::listOptionKinds for the list of valid option types that can be provided.
2963 * @see User::listOptionKinds
2964 * @param IContextSource $context
2965 * @param array $options Assoc. array with options keys to check as keys.
2966 * Defaults to $this->mOptions.
2967 * @return array The key => kind mapping data
2969 public function getOptionKinds( IContextSource
$context, $options = null ) {
2970 $this->loadOptions();
2971 if ( $options === null ) {
2972 $options = $this->mOptions
;
2975 $prefs = Preferences
::getPreferences( $this, $context );
2978 // Pull out the "special" options, so they don't get converted as
2979 // multiselect or checkmatrix.
2980 $specialOptions = array_fill_keys( Preferences
::getSaveBlacklist(), true );
2981 foreach ( $specialOptions as $name => $value ) {
2982 unset( $prefs[$name] );
2985 // Multiselect and checkmatrix options are stored in the database with
2986 // one key per option, each having a boolean value. Extract those keys.
2987 $multiselectOptions = [];
2988 foreach ( $prefs as $name => $info ) {
2989 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
2990 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
2991 $opts = HTMLFormField
::flattenOptions( $info['options'] );
2992 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2994 foreach ( $opts as $value ) {
2995 $multiselectOptions["$prefix$value"] = true;
2998 unset( $prefs[$name] );
3001 $checkmatrixOptions = [];
3002 foreach ( $prefs as $name => $info ) {
3003 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3004 ( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
3005 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3006 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3007 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
3009 foreach ( $columns as $column ) {
3010 foreach ( $rows as $row ) {
3011 $checkmatrixOptions["$prefix$column-$row"] = true;
3015 unset( $prefs[$name] );
3019 // $value is ignored
3020 foreach ( $options as $key => $value ) {
3021 if ( isset( $prefs[$key] ) ) {
3022 $mapping[$key] = 'registered';
3023 } elseif ( isset( $multiselectOptions[$key] ) ) {
3024 $mapping[$key] = 'registered-multiselect';
3025 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3026 $mapping[$key] = 'registered-checkmatrix';
3027 } elseif ( isset( $specialOptions[$key] ) ) {
3028 $mapping[$key] = 'special';
3029 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3030 $mapping[$key] = 'userjs';
3032 $mapping[$key] = 'unused';
3040 * Reset certain (or all) options to the site defaults
3042 * The optional parameter determines which kinds of preferences will be reset.
3043 * Supported values are everything that can be reported by getOptionKinds()
3044 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3046 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3047 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3048 * for backwards-compatibility.
3049 * @param IContextSource|null $context Context source used when $resetKinds
3050 * does not contain 'all', passed to getOptionKinds().
3051 * Defaults to RequestContext::getMain() when null.
3053 public function resetOptions(
3054 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3055 IContextSource
$context = null
3058 $defaultOptions = self
::getDefaultOptions();
3060 if ( !is_array( $resetKinds ) ) {
3061 $resetKinds = [ $resetKinds ];
3064 if ( in_array( 'all', $resetKinds ) ) {
3065 $newOptions = $defaultOptions;
3067 if ( $context === null ) {
3068 $context = RequestContext
::getMain();
3071 $optionKinds = $this->getOptionKinds( $context );
3072 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3075 // Use default values for the options that should be deleted, and
3076 // copy old values for the ones that shouldn't.
3077 foreach ( $this->mOptions
as $key => $value ) {
3078 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3079 if ( array_key_exists( $key, $defaultOptions ) ) {
3080 $newOptions[$key] = $defaultOptions[$key];
3083 $newOptions[$key] = $value;
3088 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3090 $this->mOptions
= $newOptions;
3091 $this->mOptionsLoaded
= true;
3095 * Get the user's preferred date format.
3096 * @return string User's preferred date format
3098 public function getDatePreference() {
3099 // Important migration for old data rows
3100 if ( is_null( $this->mDatePreference
) ) {
3102 $value = $this->getOption( 'date' );
3103 $map = $wgLang->getDatePreferenceMigrationMap();
3104 if ( isset( $map[$value] ) ) {
3105 $value = $map[$value];
3107 $this->mDatePreference
= $value;
3109 return $this->mDatePreference
;
3113 * Determine based on the wiki configuration and the user's options,
3114 * whether this user must be over HTTPS no matter what.
3118 public function requiresHTTPS() {
3119 global $wgSecureLogin;
3120 if ( !$wgSecureLogin ) {
3123 $https = $this->getBoolOption( 'prefershttps' );
3124 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3126 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3133 * Get the user preferred stub threshold
3137 public function getStubThreshold() {
3138 global $wgMaxArticleSize; # Maximum article size, in Kb
3139 $threshold = $this->getIntOption( 'stubthreshold' );
3140 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3141 // If they have set an impossible value, disable the preference
3142 // so we can use the parser cache again.
3149 * Get the permissions this user has.
3150 * @return array Array of String permission names
3152 public function getRights() {
3153 if ( is_null( $this->mRights
) ) {
3154 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3155 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3157 // Deny any rights denied by the user's session, unless this
3158 // endpoint has no sessions.
3159 if ( !defined( 'MW_NO_SESSION' ) ) {
3160 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3161 if ( $allowedRights !== null ) {
3162 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3166 // Force reindexation of rights when a hook has unset one of them
3167 $this->mRights
= array_values( array_unique( $this->mRights
) );
3169 // If block disables login, we should also remove any
3170 // extra rights blocked users might have, in case the
3171 // blocked user has a pre-existing session (T129738).
3172 // This is checked here for cases where people only call
3173 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3174 // to give a better error message in the common case.
3175 $config = RequestContext
::getMain()->getConfig();
3177 $this->isLoggedIn() &&
3178 $config->get( 'BlockDisablesLogin' ) &&
3182 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3185 return $this->mRights
;
3189 * Get the list of explicit group memberships this user has.
3190 * The implicit * and user groups are not included.
3191 * @return array Array of String internal group names
3193 public function getGroups() {
3195 $this->loadGroups();
3196 return $this->mGroups
;
3200 * Get the list of implicit group memberships this user has.
3201 * This includes all explicit groups, plus 'user' if logged in,
3202 * '*' for all accounts, and autopromoted groups
3203 * @param bool $recache Whether to avoid the cache
3204 * @return array Array of String internal group names
3206 public function getEffectiveGroups( $recache = false ) {
3207 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3208 $this->mEffectiveGroups
= array_unique( array_merge(
3209 $this->getGroups(), // explicit groups
3210 $this->getAutomaticGroups( $recache ) // implicit groups
3212 // Hook for additional groups
3213 Hooks
::run( 'UserEffectiveGroups', [ &$this, &$this->mEffectiveGroups
] );
3214 // Force reindexation of groups when a hook has unset one of them
3215 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3217 return $this->mEffectiveGroups
;
3221 * Get the list of implicit group memberships this user has.
3222 * This includes 'user' if logged in, '*' for all accounts,
3223 * and autopromoted groups
3224 * @param bool $recache Whether to avoid the cache
3225 * @return array Array of String internal group names
3227 public function getAutomaticGroups( $recache = false ) {
3228 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3229 $this->mImplicitGroups
= [ '*' ];
3230 if ( $this->getId() ) {
3231 $this->mImplicitGroups
[] = 'user';
3233 $this->mImplicitGroups
= array_unique( array_merge(
3234 $this->mImplicitGroups
,
3235 Autopromote
::getAutopromoteGroups( $this )
3239 // Assure data consistency with rights/groups,
3240 // as getEffectiveGroups() depends on this function
3241 $this->mEffectiveGroups
= null;
3244 return $this->mImplicitGroups
;
3248 * Returns the groups the user has belonged to.
3250 * The user may still belong to the returned groups. Compare with getGroups().
3252 * The function will not return groups the user had belonged to before MW 1.17
3254 * @return array Names of the groups the user has belonged to.
3256 public function getFormerGroups() {
3259 if ( is_null( $this->mFormerGroups
) ) {
3260 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3261 ?
wfGetDB( DB_MASTER
)
3262 : wfGetDB( DB_REPLICA
);
3263 $res = $db->select( 'user_former_groups',
3265 [ 'ufg_user' => $this->mId
],
3267 $this->mFormerGroups
= [];
3268 foreach ( $res as $row ) {
3269 $this->mFormerGroups
[] = $row->ufg_group
;
3273 return $this->mFormerGroups
;
3277 * Get the user's edit count.
3278 * @return int|null Null for anonymous users
3280 public function getEditCount() {
3281 if ( !$this->getId() ) {
3285 if ( $this->mEditCount
=== null ) {
3286 /* Populate the count, if it has not been populated yet */
3287 $dbr = wfGetDB( DB_REPLICA
);
3288 // check if the user_editcount field has been initialized
3289 $count = $dbr->selectField(
3290 'user', 'user_editcount',
3291 [ 'user_id' => $this->mId
],
3295 if ( $count === null ) {
3296 // it has not been initialized. do so.
3297 $count = $this->initEditCount();
3299 $this->mEditCount
= $count;
3301 return (int)$this->mEditCount
;
3305 * Add the user to the given group.
3306 * This takes immediate effect.
3307 * @param string $group Name of the group to add
3310 public function addGroup( $group ) {
3313 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group ] ) ) {
3317 $dbw = wfGetDB( DB_MASTER
);
3318 if ( $this->getId() ) {
3319 $dbw->insert( 'user_groups',
3321 'ug_user' => $this->getId(),
3322 'ug_group' => $group,
3328 $this->loadGroups();
3329 $this->mGroups
[] = $group;
3330 // In case loadGroups was not called before, we now have the right twice.
3331 // Get rid of the duplicate.
3332 $this->mGroups
= array_unique( $this->mGroups
);
3334 // Refresh the groups caches, and clear the rights cache so it will be
3335 // refreshed on the next call to $this->getRights().
3336 $this->getEffectiveGroups( true );
3337 $this->mRights
= null;
3339 $this->invalidateCache();
3345 * Remove the user from the given group.
3346 * This takes immediate effect.
3347 * @param string $group Name of the group to remove
3350 public function removeGroup( $group ) {
3352 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3356 $dbw = wfGetDB( DB_MASTER
);
3357 $dbw->delete( 'user_groups',
3359 'ug_user' => $this->getId(),
3360 'ug_group' => $group,
3363 // Remember that the user was in this group
3364 $dbw->insert( 'user_former_groups',
3366 'ufg_user' => $this->getId(),
3367 'ufg_group' => $group,
3373 $this->loadGroups();
3374 $this->mGroups
= array_diff( $this->mGroups
, [ $group ] );
3376 // Refresh the groups caches, and clear the rights cache so it will be
3377 // refreshed on the next call to $this->getRights().
3378 $this->getEffectiveGroups( true );
3379 $this->mRights
= null;
3381 $this->invalidateCache();
3387 * Get whether the user is logged in
3390 public function isLoggedIn() {
3391 return $this->getId() != 0;
3395 * Get whether the user is anonymous
3398 public function isAnon() {
3399 return !$this->isLoggedIn();
3403 * @return bool Whether this user is flagged as being a bot role account
3406 public function isBot() {
3407 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3412 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3418 * Check if user is allowed to access a feature / make an action
3420 * @param string ... Permissions to test
3421 * @return bool True if user is allowed to perform *any* of the given actions
3423 public function isAllowedAny() {
3424 $permissions = func_get_args();
3425 foreach ( $permissions as $permission ) {
3426 if ( $this->isAllowed( $permission ) ) {
3435 * @param string ... Permissions to test
3436 * @return bool True if the user is allowed to perform *all* of the given actions
3438 public function isAllowedAll() {
3439 $permissions = func_get_args();
3440 foreach ( $permissions as $permission ) {
3441 if ( !$this->isAllowed( $permission ) ) {
3449 * Internal mechanics of testing a permission
3450 * @param string $action
3453 public function isAllowed( $action = '' ) {
3454 if ( $action === '' ) {
3455 return true; // In the spirit of DWIM
3457 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3458 // by misconfiguration: 0 == 'foo'
3459 return in_array( $action, $this->getRights(), true );
3463 * Check whether to enable recent changes patrol features for this user
3464 * @return bool True or false
3466 public function useRCPatrol() {
3467 global $wgUseRCPatrol;
3468 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3472 * Check whether to enable new pages patrol features for this user
3473 * @return bool True or false
3475 public function useNPPatrol() {
3476 global $wgUseRCPatrol, $wgUseNPPatrol;
3478 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3479 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3484 * Check whether to enable new files patrol features for this user
3485 * @return bool True or false
3487 public function useFilePatrol() {
3488 global $wgUseRCPatrol, $wgUseFilePatrol;
3490 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3491 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3496 * Get the WebRequest object to use with this object
3498 * @return WebRequest
3500 public function getRequest() {
3501 if ( $this->mRequest
) {
3502 return $this->mRequest
;
3510 * Check the watched status of an article.
3511 * @since 1.22 $checkRights parameter added
3512 * @param Title $title Title of the article to look at
3513 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3514 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3517 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3518 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3519 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3526 * @since 1.22 $checkRights parameter added
3527 * @param Title $title Title of the article to look at
3528 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3529 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3531 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3532 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3533 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3535 [ $title->getSubjectPage(), $title->getTalkPage() ]
3538 $this->invalidateCache();
3542 * Stop watching an article.
3543 * @since 1.22 $checkRights parameter added
3544 * @param Title $title Title of the article to look at
3545 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3546 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3548 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3549 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3550 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3551 $store->removeWatch( $this, $title->getSubjectPage() );
3552 $store->removeWatch( $this, $title->getTalkPage() );
3554 $this->invalidateCache();
3558 * Clear the user's notification timestamp for the given title.
3559 * If e-notif e-mails are on, they will receive notification mails on
3560 * the next change of the page if it's watched etc.
3561 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3562 * @param Title $title Title of the article to look at
3563 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3565 public function clearNotification( &$title, $oldid = 0 ) {
3566 global $wgUseEnotif, $wgShowUpdatedMarker;
3568 // Do nothing if the database is locked to writes
3569 if ( wfReadOnly() ) {
3573 // Do nothing if not allowed to edit the watchlist
3574 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3578 // If we're working on user's talk page, we should update the talk page message indicator
3579 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3580 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$this, $oldid ] ) ) {
3584 // Try to update the DB post-send and only if needed...
3585 DeferredUpdates
::addCallableUpdate( function() use ( $title, $oldid ) {
3586 if ( !$this->getNewtalk() ) {
3587 return; // no notifications to clear
3590 // Delete the last notifications (they stack up)
3591 $this->setNewtalk( false );
3593 // If there is a new, unseen, revision, use its timestamp
3595 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
3598 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
3603 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3607 if ( $this->isAnon() ) {
3608 // Nothing else to do...
3612 // Only update the timestamp if the page is being watched.
3613 // The query to find out if it is watched is cached both in memcached and per-invocation,
3614 // and when it does have to be executed, it can be on a replica DB
3615 // If this is the user's newtalk page, we always update the timestamp
3617 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3621 MediaWikiServices
::getInstance()->getWatchedItemStore()
3622 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
3626 * Resets all of the given user's page-change notification timestamps.
3627 * If e-notif e-mails are on, they will receive notification mails on
3628 * the next change of any watched page.
3629 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3631 public function clearAllNotifications() {
3632 global $wgUseEnotif, $wgShowUpdatedMarker;
3633 // Do nothing if not allowed to edit the watchlist
3634 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
3638 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3639 $this->setNewtalk( false );
3643 $id = $this->getId();
3648 $dbw = wfGetDB( DB_MASTER
);
3649 $asOfTimes = array_unique( $dbw->selectFieldValues(
3651 'wl_notificationtimestamp',
3652 [ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ],
3654 [ 'ORDER BY' => 'wl_notificationtimestamp DESC', 'LIMIT' => 500 ]
3656 if ( !$asOfTimes ) {
3659 // Immediately update the most recent touched rows, which hopefully covers what
3660 // the user sees on the watchlist page before pressing "mark all pages visited"....
3663 [ 'wl_notificationtimestamp' => null ],
3664 [ 'wl_user' => $id, 'wl_notificationtimestamp' => $asOfTimes ],
3667 // ...and finish the older ones in a post-send update with lag checks...
3668 DeferredUpdates
::addUpdate( new AutoCommitUpdate(
3671 function () use ( $dbw, $id ) {
3672 global $wgUpdateRowsPerQuery;
3674 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
3675 $ticket = $lbFactory->getEmptyTransactionTicket( __METHOD__
);
3676 $asOfTimes = array_unique( $dbw->selectFieldValues(
3678 'wl_notificationtimestamp',
3679 [ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ],
3682 foreach ( array_chunk( $asOfTimes, $wgUpdateRowsPerQuery ) as $asOfTimeBatch ) {
3685 [ 'wl_notificationtimestamp' => null ],
3686 [ 'wl_user' => $id, 'wl_notificationtimestamp' => $asOfTimeBatch ],
3689 $lbFactory->commitAndWaitForReplication( __METHOD__
, $ticket );
3693 // We also need to clear here the "you have new message" notification for the own
3694 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
3698 * Set a cookie on the user's client. Wrapper for
3699 * WebResponse::setCookie
3700 * @deprecated since 1.27
3701 * @param string $name Name of the cookie to set
3702 * @param string $value Value to set
3703 * @param int $exp Expiration time, as a UNIX time value;
3704 * if 0 or not specified, use the default $wgCookieExpiration
3705 * @param bool $secure
3706 * true: Force setting the secure attribute when setting the cookie
3707 * false: Force NOT setting the secure attribute when setting the cookie
3708 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3709 * @param array $params Array of options sent passed to WebResponse::setcookie()
3710 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3713 protected function setCookie(
3714 $name, $value, $exp = 0, $secure = null, $params = [], $request = null
3716 wfDeprecated( __METHOD__
, '1.27' );
3717 if ( $request === null ) {
3718 $request = $this->getRequest();
3720 $params['secure'] = $secure;
3721 $request->response()->setCookie( $name, $value, $exp, $params );
3725 * Clear a cookie on the user's client
3726 * @deprecated since 1.27
3727 * @param string $name Name of the cookie to clear
3728 * @param bool $secure
3729 * true: Force setting the secure attribute when setting the cookie
3730 * false: Force NOT setting the secure attribute when setting the cookie
3731 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3732 * @param array $params Array of options sent passed to WebResponse::setcookie()
3734 protected function clearCookie( $name, $secure = null, $params = [] ) {
3735 wfDeprecated( __METHOD__
, '1.27' );
3736 $this->setCookie( $name, '', time() - 86400, $secure, $params );
3740 * Set an extended login cookie on the user's client. The expiry of the cookie
3741 * is controlled by the $wgExtendedLoginCookieExpiration configuration
3744 * @see User::setCookie
3746 * @deprecated since 1.27
3747 * @param string $name Name of the cookie to set
3748 * @param string $value Value to set
3749 * @param bool $secure
3750 * true: Force setting the secure attribute when setting the cookie
3751 * false: Force NOT setting the secure attribute when setting the cookie
3752 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3754 protected function setExtendedLoginCookie( $name, $value, $secure ) {
3755 global $wgExtendedLoginCookieExpiration, $wgCookieExpiration;
3757 wfDeprecated( __METHOD__
, '1.27' );
3760 $exp +
= $wgExtendedLoginCookieExpiration !== null
3761 ?
$wgExtendedLoginCookieExpiration
3762 : $wgCookieExpiration;
3764 $this->setCookie( $name, $value, $exp, $secure );
3768 * Persist this user's session (e.g. set cookies)
3770 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3772 * @param bool $secure Whether to force secure/insecure cookies or use default
3773 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3775 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3777 if ( 0 == $this->mId
) {
3781 $session = $this->getRequest()->getSession();
3782 if ( $request && $session->getRequest() !== $request ) {
3783 $session = $session->sessionWithRequest( $request );
3785 $delay = $session->delaySave();
3787 if ( !$session->getUser()->equals( $this ) ) {
3788 if ( !$session->canSetUser() ) {
3789 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3790 ->warning( __METHOD__
.
3791 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
3795 $session->setUser( $this );
3798 $session->setRememberUser( $rememberMe );
3799 if ( $secure !== null ) {
3800 $session->setForceHTTPS( $secure );
3803 $session->persist();
3805 ScopedCallback
::consume( $delay );
3809 * Log this user out.
3811 public function logout() {
3812 if ( Hooks
::run( 'UserLogout', [ &$this ] ) ) {
3818 * Clear the user's session, and reset the instance cache.
3821 public function doLogout() {
3822 $session = $this->getRequest()->getSession();
3823 if ( !$session->canSetUser() ) {
3824 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3825 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
3826 $error = 'immutable';
3827 } elseif ( !$session->getUser()->equals( $this ) ) {
3828 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3829 ->warning( __METHOD__
.
3830 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
3832 // But we still may as well make this user object anon
3833 $this->clearInstanceCache( 'defaults' );
3834 $error = 'wronguser';
3836 $this->clearInstanceCache( 'defaults' );
3837 $delay = $session->delaySave();
3838 $session->unpersist(); // Clear cookies (T127436)
3839 $session->setLoggedOutTimestamp( time() );
3840 $session->setUser( new User
);
3841 $session->set( 'wsUserID', 0 ); // Other code expects this
3842 $session->resetAllTokens();
3843 ScopedCallback
::consume( $delay );
3846 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
3847 'event' => 'logout',
3848 'successful' => $error === false,
3849 'status' => $error ?
: 'success',
3854 * Save this user's settings into the database.
3855 * @todo Only rarely do all these fields need to be set!
3857 public function saveSettings() {
3858 if ( wfReadOnly() ) {
3859 // @TODO: caller should deal with this instead!
3860 // This should really just be an exception.
3861 MWExceptionHandler
::logException( new DBExpectedError(
3863 "Could not update user with ID '{$this->mId}'; DB is read-only."
3869 if ( 0 == $this->mId
) {
3873 // Get a new user_touched that is higher than the old one.
3874 // This will be used for a CAS check as a last-resort safety
3875 // check against race conditions and replica DB lag.
3876 $newTouched = $this->newTouchedTimestamp();
3878 $dbw = wfGetDB( DB_MASTER
);
3879 $dbw->update( 'user',
3881 'user_name' => $this->mName
,
3882 'user_real_name' => $this->mRealName
,
3883 'user_email' => $this->mEmail
,
3884 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3885 'user_touched' => $dbw->timestamp( $newTouched ),
3886 'user_token' => strval( $this->mToken
),
3887 'user_email_token' => $this->mEmailToken
,
3888 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
3889 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
3890 'user_id' => $this->mId
,
3894 if ( !$dbw->affectedRows() ) {
3895 // Maybe the problem was a missed cache update; clear it to be safe
3896 $this->clearSharedCache( 'refresh' );
3897 // User was changed in the meantime or loaded with stale data
3898 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
3899 throw new MWException(
3900 "CAS update failed on user_touched for user ID '{$this->mId}' (read from $from);" .
3901 " the version of the user to be saved is older than the current version."
3905 $this->mTouched
= $newTouched;
3906 $this->saveOptions();
3908 Hooks
::run( 'UserSaveSettings', [ $this ] );
3909 $this->clearSharedCache();
3910 $this->getUserPage()->invalidateCache();
3914 * If only this user's username is known, and it exists, return the user ID.
3916 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
3919 public function idForName( $flags = 0 ) {
3920 $s = trim( $this->getName() );
3925 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
3926 ?
wfGetDB( DB_MASTER
)
3927 : wfGetDB( DB_REPLICA
);
3929 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
3930 ?
[ 'LOCK IN SHARE MODE' ]
3933 $id = $db->selectField( 'user',
3934 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
3940 * Add a user to the database, return the user object
3942 * @param string $name Username to add
3943 * @param array $params Array of Strings Non-default parameters to save to
3944 * the database as user_* fields:
3945 * - email: The user's email address.
3946 * - email_authenticated: The email authentication timestamp.
3947 * - real_name: The user's real name.
3948 * - options: An associative array of non-default options.
3949 * - token: Random authentication token. Do not set.
3950 * - registration: Registration timestamp. Do not set.
3952 * @return User|null User object, or null if the username already exists.
3954 public static function createNew( $name, $params = [] ) {
3955 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
3956 if ( isset( $params[$field] ) ) {
3957 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
3958 unset( $params[$field] );
3964 $user->setToken(); // init token
3965 if ( isset( $params['options'] ) ) {
3966 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
3967 unset( $params['options'] );
3969 $dbw = wfGetDB( DB_MASTER
);
3970 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3972 $noPass = PasswordFactory
::newInvalidPassword()->toString();
3975 'user_id' => $seqVal,
3976 'user_name' => $name,
3977 'user_password' => $noPass,
3978 'user_newpassword' => $noPass,
3979 'user_email' => $user->mEmail
,
3980 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
3981 'user_real_name' => $user->mRealName
,
3982 'user_token' => strval( $user->mToken
),
3983 'user_registration' => $dbw->timestamp( $user->mRegistration
),
3984 'user_editcount' => 0,
3985 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
3987 foreach ( $params as $name => $value ) {
3988 $fields["user_$name"] = $value;
3990 $dbw->insert( 'user', $fields, __METHOD__
, [ 'IGNORE' ] );
3991 if ( $dbw->affectedRows() ) {
3992 $newUser = User
::newFromId( $dbw->insertId() );
4000 * Add this existing user object to the database. If the user already
4001 * exists, a fatal status object is returned, and the user object is
4002 * initialised with the data from the database.
4004 * Previously, this function generated a DB error due to a key conflict
4005 * if the user already existed. Many extension callers use this function
4006 * in code along the lines of:
4008 * $user = User::newFromName( $name );
4009 * if ( !$user->isLoggedIn() ) {
4010 * $user->addToDatabase();
4012 * // do something with $user...
4014 * However, this was vulnerable to a race condition (bug 16020). By
4015 * initialising the user object if the user exists, we aim to support this
4016 * calling sequence as far as possible.
4018 * Note that if the user exists, this function will acquire a write lock,
4019 * so it is still advisable to make the call conditional on isLoggedIn(),
4020 * and to commit the transaction after calling.
4022 * @throws MWException
4025 public function addToDatabase() {
4027 if ( !$this->mToken
) {
4028 $this->setToken(); // init token
4031 $this->mTouched
= $this->newTouchedTimestamp();
4033 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4035 $dbw = wfGetDB( DB_MASTER
);
4036 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
4037 $dbw->insert( 'user',
4039 'user_id' => $seqVal,
4040 'user_name' => $this->mName
,
4041 'user_password' => $noPass,
4042 'user_newpassword' => $noPass,
4043 'user_email' => $this->mEmail
,
4044 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4045 'user_real_name' => $this->mRealName
,
4046 'user_token' => strval( $this->mToken
),
4047 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4048 'user_editcount' => 0,
4049 'user_touched' => $dbw->timestamp( $this->mTouched
),
4053 if ( !$dbw->affectedRows() ) {
4054 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4055 $this->mId
= $dbw->selectField(
4058 [ 'user_name' => $this->mName
],
4060 [ 'LOCK IN SHARE MODE' ]
4064 if ( $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4069 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
4070 "to insert user '{$this->mName}' row, but it was not present in select!" );
4072 return Status
::newFatal( 'userexists' );
4074 $this->mId
= $dbw->insertId();
4075 self
::$idCacheByName[$this->mName
] = $this->mId
;
4077 // Clear instance cache other than user table data, which is already accurate
4078 $this->clearInstanceCache();
4080 $this->saveOptions();
4081 return Status
::newGood();
4085 * If this user is logged-in and blocked,
4086 * block any IP address they've successfully logged in from.
4087 * @return bool A block was spread
4089 public function spreadAnyEditBlock() {
4090 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4091 return $this->spreadBlock();
4098 * If this (non-anonymous) user is blocked,
4099 * block the IP address they've successfully logged in from.
4100 * @return bool A block was spread
4102 protected function spreadBlock() {
4103 wfDebug( __METHOD__
. "()\n" );
4105 if ( $this->mId
== 0 ) {
4109 $userblock = Block
::newFromTarget( $this->getName() );
4110 if ( !$userblock ) {
4114 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4118 * Get whether the user is explicitly blocked from account creation.
4119 * @return bool|Block
4121 public function isBlockedFromCreateAccount() {
4122 $this->getBlockedStatus();
4123 if ( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
4124 return $this->mBlock
;
4127 # bug 13611: if the IP address the user is trying to create an account from is
4128 # blocked with createaccount disabled, prevent new account creation there even
4129 # when the user is logged in
4130 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4131 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4133 return $this->mBlockedFromCreateAccount
instanceof Block
4134 && $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
4135 ?
$this->mBlockedFromCreateAccount
4140 * Get whether the user is blocked from using Special:Emailuser.
4143 public function isBlockedFromEmailuser() {
4144 $this->getBlockedStatus();
4145 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
4149 * Get whether the user is allowed to create an account.
4152 public function isAllowedToCreateAccount() {
4153 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4157 * Get this user's personal page title.
4159 * @return Title User's personal page title
4161 public function getUserPage() {
4162 return Title
::makeTitle( NS_USER
, $this->getName() );
4166 * Get this user's talk page title.
4168 * @return Title User's talk page title
4170 public function getTalkPage() {
4171 $title = $this->getUserPage();
4172 return $title->getTalkPage();
4176 * Determine whether the user is a newbie. Newbies are either
4177 * anonymous IPs, or the most recently created accounts.
4180 public function isNewbie() {
4181 return !$this->isAllowed( 'autoconfirmed' );
4185 * Check to see if the given clear-text password is one of the accepted passwords
4186 * @deprecated since 1.27, use AuthManager instead
4187 * @param string $password User password
4188 * @return bool True if the given password is correct, otherwise False
4190 public function checkPassword( $password ) {
4191 $manager = AuthManager
::singleton();
4192 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4193 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4195 'username' => $this->getName(),
4196 'password' => $password,
4199 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4200 switch ( $res->status
) {
4201 case AuthenticationResponse
::PASS
:
4203 case AuthenticationResponse
::FAIL
:
4204 // Hope it's not a PreAuthenticationProvider that failed...
4205 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4206 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4209 throw new BadMethodCallException(
4210 'AuthManager returned a response unsupported by ' . __METHOD__
4216 * Check if the given clear-text password matches the temporary password
4217 * sent by e-mail for password reset operations.
4219 * @deprecated since 1.27, use AuthManager instead
4220 * @param string $plaintext
4221 * @return bool True if matches, false otherwise
4223 public function checkTemporaryPassword( $plaintext ) {
4224 // Can't check the temporary password individually.
4225 return $this->checkPassword( $plaintext );
4229 * Initialize (if necessary) and return a session token value
4230 * which can be used in edit forms to show that the user's
4231 * login credentials aren't being hijacked with a foreign form
4235 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4236 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4237 * @return MediaWiki\Session\Token The new edit token
4239 public function getEditTokenObject( $salt = '', $request = null ) {
4240 if ( $this->isAnon() ) {
4241 return new LoggedOutEditToken();
4245 $request = $this->getRequest();
4247 return $request->getSession()->getToken( $salt );
4251 * Initialize (if necessary) and return a session token value
4252 * which can be used in edit forms to show that the user's
4253 * login credentials aren't being hijacked with a foreign form
4256 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4259 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4260 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4261 * @return string The new edit token
4263 public function getEditToken( $salt = '', $request = null ) {
4264 return $this->getEditTokenObject( $salt, $request )->toString();
4268 * Get the embedded timestamp from a token.
4269 * @deprecated since 1.27, use \MediaWiki\Session\Token::getTimestamp instead.
4270 * @param string $val Input token
4273 public static function getEditTokenTimestamp( $val ) {
4274 wfDeprecated( __METHOD__
, '1.27' );
4275 return MediaWiki\Session\Token
::getTimestamp( $val );
4279 * Check given value against the token value stored in the session.
4280 * A match should confirm that the form was submitted from the
4281 * user's own login session, not a form submission from a third-party
4284 * @param string $val Input value to compare
4285 * @param string $salt Optional function-specific data for hashing
4286 * @param WebRequest|null $request Object to use or null to use $wgRequest
4287 * @param int $maxage Fail tokens older than this, in seconds
4288 * @return bool Whether the token matches
4290 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4291 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4295 * Check given value against the token value stored in the session,
4296 * ignoring the suffix.
4298 * @param string $val Input value to compare
4299 * @param string $salt Optional function-specific data for hashing
4300 * @param WebRequest|null $request Object to use or null to use $wgRequest
4301 * @param int $maxage Fail tokens older than this, in seconds
4302 * @return bool Whether the token matches
4304 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4305 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4306 return $this->matchEditToken( $val, $salt, $request, $maxage );
4310 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4311 * mail to the user's given address.
4313 * @param string $type Message to send, either "created", "changed" or "set"
4316 public function sendConfirmationMail( $type = 'created' ) {
4318 $expiration = null; // gets passed-by-ref and defined in next line.
4319 $token = $this->confirmationToken( $expiration );
4320 $url = $this->confirmationTokenUrl( $token );
4321 $invalidateURL = $this->invalidationTokenUrl( $token );
4322 $this->saveSettings();
4324 if ( $type == 'created' ||
$type === false ) {
4325 $message = 'confirmemail_body';
4326 } elseif ( $type === true ) {
4327 $message = 'confirmemail_body_changed';
4329 // Messages: confirmemail_body_changed, confirmemail_body_set
4330 $message = 'confirmemail_body_' . $type;
4333 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4334 wfMessage( $message,
4335 $this->getRequest()->getIP(),
4338 $wgLang->userTimeAndDate( $expiration, $this ),
4340 $wgLang->userDate( $expiration, $this ),
4341 $wgLang->userTime( $expiration, $this ) )->text() );
4345 * Send an e-mail to this user's account. Does not check for
4346 * confirmed status or validity.
4348 * @param string $subject Message subject
4349 * @param string $body Message body
4350 * @param User|null $from Optional sending user; if unspecified, default
4351 * $wgPasswordSender will be used.
4352 * @param string $replyto Reply-To address
4355 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4356 global $wgPasswordSender;
4358 if ( $from instanceof User
) {
4359 $sender = MailAddress
::newFromUser( $from );
4361 $sender = new MailAddress( $wgPasswordSender,
4362 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4364 $to = MailAddress
::newFromUser( $this );
4366 return UserMailer
::send( $to, $sender, $subject, $body, [
4367 'replyTo' => $replyto,
4372 * Generate, store, and return a new e-mail confirmation code.
4373 * A hash (unsalted, since it's used as a key) is stored.
4375 * @note Call saveSettings() after calling this function to commit
4376 * this change to the database.
4378 * @param string &$expiration Accepts the expiration time
4379 * @return string New token
4381 protected function confirmationToken( &$expiration ) {
4382 global $wgUserEmailConfirmationTokenExpiry;
4384 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4385 $expiration = wfTimestamp( TS_MW
, $expires );
4387 $token = MWCryptRand
::generateHex( 32 );
4388 $hash = md5( $token );
4389 $this->mEmailToken
= $hash;
4390 $this->mEmailTokenExpires
= $expiration;
4395 * Return a URL the user can use to confirm their email address.
4396 * @param string $token Accepts the email confirmation token
4397 * @return string New token URL
4399 protected function confirmationTokenUrl( $token ) {
4400 return $this->getTokenUrl( 'ConfirmEmail', $token );
4404 * Return a URL the user can use to invalidate their email address.
4405 * @param string $token Accepts the email confirmation token
4406 * @return string New token URL
4408 protected function invalidationTokenUrl( $token ) {
4409 return $this->getTokenUrl( 'InvalidateEmail', $token );
4413 * Internal function to format the e-mail validation/invalidation URLs.
4414 * This uses a quickie hack to use the
4415 * hardcoded English names of the Special: pages, for ASCII safety.
4417 * @note Since these URLs get dropped directly into emails, using the
4418 * short English names avoids insanely long URL-encoded links, which
4419 * also sometimes can get corrupted in some browsers/mailers
4420 * (bug 6957 with Gmail and Internet Explorer).
4422 * @param string $page Special page
4423 * @param string $token Token
4424 * @return string Formatted URL
4426 protected function getTokenUrl( $page, $token ) {
4427 // Hack to bypass localization of 'Special:'
4428 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4429 return $title->getCanonicalURL();
4433 * Mark the e-mail address confirmed.
4435 * @note Call saveSettings() after calling this function to commit the change.
4439 public function confirmEmail() {
4440 // Check if it's already confirmed, so we don't touch the database
4441 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4442 if ( !$this->isEmailConfirmed() ) {
4443 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4444 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4450 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4451 * address if it was already confirmed.
4453 * @note Call saveSettings() after calling this function to commit the change.
4454 * @return bool Returns true
4456 public function invalidateEmail() {
4458 $this->mEmailToken
= null;
4459 $this->mEmailTokenExpires
= null;
4460 $this->setEmailAuthenticationTimestamp( null );
4462 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4467 * Set the e-mail authentication timestamp.
4468 * @param string $timestamp TS_MW timestamp
4470 public function setEmailAuthenticationTimestamp( $timestamp ) {
4472 $this->mEmailAuthenticated
= $timestamp;
4473 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4477 * Is this user allowed to send e-mails within limits of current
4478 * site configuration?
4481 public function canSendEmail() {
4482 global $wgEnableEmail, $wgEnableUserEmail;
4483 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4486 $canSend = $this->isEmailConfirmed();
4487 Hooks
::run( 'UserCanSendEmail', [ &$this, &$canSend ] );
4492 * Is this user allowed to receive e-mails within limits of current
4493 * site configuration?
4496 public function canReceiveEmail() {
4497 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4501 * Is this user's e-mail address valid-looking and confirmed within
4502 * limits of the current site configuration?
4504 * @note If $wgEmailAuthentication is on, this may require the user to have
4505 * confirmed their address by returning a code or using a password
4506 * sent to the address from the wiki.
4510 public function isEmailConfirmed() {
4511 global $wgEmailAuthentication;
4514 if ( Hooks
::run( 'EmailConfirmed', [ &$this, &$confirmed ] ) ) {
4515 if ( $this->isAnon() ) {
4518 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4521 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4531 * Check whether there is an outstanding request for e-mail confirmation.
4534 public function isEmailConfirmationPending() {
4535 global $wgEmailAuthentication;
4536 return $wgEmailAuthentication &&
4537 !$this->isEmailConfirmed() &&
4538 $this->mEmailToken
&&
4539 $this->mEmailTokenExpires
> wfTimestamp();
4543 * Get the timestamp of account creation.
4545 * @return string|bool|null Timestamp of account creation, false for
4546 * non-existent/anonymous user accounts, or null if existing account
4547 * but information is not in database.
4549 public function getRegistration() {
4550 if ( $this->isAnon() ) {
4554 return $this->mRegistration
;
4558 * Get the timestamp of the first edit
4560 * @return string|bool Timestamp of first edit, or false for
4561 * non-existent/anonymous user accounts.
4563 public function getFirstEditTimestamp() {
4564 if ( $this->getId() == 0 ) {
4565 return false; // anons
4567 $dbr = wfGetDB( DB_REPLICA
);
4568 $time = $dbr->selectField( 'revision', 'rev_timestamp',
4569 [ 'rev_user' => $this->getId() ],
4571 [ 'ORDER BY' => 'rev_timestamp ASC' ]
4574 return false; // no edits
4576 return wfTimestamp( TS_MW
, $time );
4580 * Get the permissions associated with a given list of groups
4582 * @param array $groups Array of Strings List of internal group names
4583 * @return array Array of Strings List of permission key names for given groups combined
4585 public static function getGroupPermissions( $groups ) {
4586 global $wgGroupPermissions, $wgRevokePermissions;
4588 // grant every granted permission first
4589 foreach ( $groups as $group ) {
4590 if ( isset( $wgGroupPermissions[$group] ) ) {
4591 $rights = array_merge( $rights,
4592 // array_filter removes empty items
4593 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4596 // now revoke the revoked permissions
4597 foreach ( $groups as $group ) {
4598 if ( isset( $wgRevokePermissions[$group] ) ) {
4599 $rights = array_diff( $rights,
4600 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4603 return array_unique( $rights );
4607 * Get all the groups who have a given permission
4609 * @param string $role Role to check
4610 * @return array Array of Strings List of internal group names with the given permission
4612 public static function getGroupsWithPermission( $role ) {
4613 global $wgGroupPermissions;
4614 $allowedGroups = [];
4615 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4616 if ( self
::groupHasPermission( $group, $role ) ) {
4617 $allowedGroups[] = $group;
4620 return $allowedGroups;
4624 * Check, if the given group has the given permission
4626 * If you're wanting to check whether all users have a permission, use
4627 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4631 * @param string $group Group to check
4632 * @param string $role Role to check
4635 public static function groupHasPermission( $group, $role ) {
4636 global $wgGroupPermissions, $wgRevokePermissions;
4637 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4638 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4642 * Check if all users may be assumed to have the given permission
4644 * We generally assume so if the right is granted to '*' and isn't revoked
4645 * on any group. It doesn't attempt to take grants or other extension
4646 * limitations on rights into account in the general case, though, as that
4647 * would require it to always return false and defeat the purpose.
4648 * Specifically, session-based rights restrictions (such as OAuth or bot
4649 * passwords) are applied based on the current session.
4652 * @param string $right Right to check
4655 public static function isEveryoneAllowed( $right ) {
4656 global $wgGroupPermissions, $wgRevokePermissions;
4659 // Use the cached results, except in unit tests which rely on
4660 // being able change the permission mid-request
4661 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
4662 return $cache[$right];
4665 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
4666 $cache[$right] = false;
4670 // If it's revoked anywhere, then everyone doesn't have it
4671 foreach ( $wgRevokePermissions as $rights ) {
4672 if ( isset( $rights[$right] ) && $rights[$right] ) {
4673 $cache[$right] = false;
4678 // Remove any rights that aren't allowed to the global-session user,
4679 // unless there are no sessions for this endpoint.
4680 if ( !defined( 'MW_NO_SESSION' ) ) {
4681 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
4682 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
4683 $cache[$right] = false;
4688 // Allow extensions to say false
4689 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
4690 $cache[$right] = false;
4694 $cache[$right] = true;
4699 * Get the localized descriptive name for a group, if it exists
4701 * @param string $group Internal group name
4702 * @return string Localized descriptive group name
4704 public static function getGroupName( $group ) {
4705 $msg = wfMessage( "group-$group" );
4706 return $msg->isBlank() ?
$group : $msg->text();
4710 * Get the localized descriptive name for a member of a group, if it exists
4712 * @param string $group Internal group name
4713 * @param string $username Username for gender (since 1.19)
4714 * @return string Localized name for group member
4716 public static function getGroupMember( $group, $username = '#' ) {
4717 $msg = wfMessage( "group-$group-member", $username );
4718 return $msg->isBlank() ?
$group : $msg->text();
4722 * Return the set of defined explicit groups.
4723 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4724 * are not included, as they are defined automatically, not in the database.
4725 * @return array Array of internal group names
4727 public static function getAllGroups() {
4728 global $wgGroupPermissions, $wgRevokePermissions;
4730 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4731 self
::getImplicitGroups()
4736 * Get a list of all available permissions.
4737 * @return string[] Array of permission names
4739 public static function getAllRights() {
4740 if ( self
::$mAllRights === false ) {
4741 global $wgAvailableRights;
4742 if ( count( $wgAvailableRights ) ) {
4743 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
4745 self
::$mAllRights = self
::$mCoreRights;
4747 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
4749 return self
::$mAllRights;
4753 * Get a list of implicit groups
4754 * @return array Array of Strings Array of internal group names
4756 public static function getImplicitGroups() {
4757 global $wgImplicitGroups;
4759 $groups = $wgImplicitGroups;
4760 # Deprecated, use $wgImplicitGroups instead
4761 Hooks
::run( 'UserGetImplicitGroups', [ &$groups ], '1.25' );
4767 * Get the title of a page describing a particular group
4769 * @param string $group Internal group name
4770 * @return Title|bool Title of the page if it exists, false otherwise
4772 public static function getGroupPage( $group ) {
4773 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
4774 if ( $msg->exists() ) {
4775 $title = Title
::newFromText( $msg->text() );
4776 if ( is_object( $title ) ) {
4784 * Create a link to the group in HTML, if available;
4785 * else return the group name.
4787 * @param string $group Internal name of the group
4788 * @param string $text The text of the link
4789 * @return string HTML link to the group
4791 public static function makeGroupLinkHTML( $group, $text = '' ) {
4792 if ( $text == '' ) {
4793 $text = self
::getGroupName( $group );
4795 $title = self
::getGroupPage( $group );
4797 return Linker
::link( $title, htmlspecialchars( $text ) );
4799 return htmlspecialchars( $text );
4804 * Create a link to the group in Wikitext, if available;
4805 * else return the group name.
4807 * @param string $group Internal name of the group
4808 * @param string $text The text of the link
4809 * @return string Wikilink to the group
4811 public static function makeGroupLinkWiki( $group, $text = '' ) {
4812 if ( $text == '' ) {
4813 $text = self
::getGroupName( $group );
4815 $title = self
::getGroupPage( $group );
4817 $page = $title->getFullText();
4818 return "[[$page|$text]]";
4825 * Returns an array of the groups that a particular group can add/remove.
4827 * @param string $group The group to check for whether it can add/remove
4828 * @return array Array( 'add' => array( addablegroups ),
4829 * 'remove' => array( removablegroups ),
4830 * 'add-self' => array( addablegroups to self),
4831 * 'remove-self' => array( removable groups from self) )
4833 public static function changeableByGroup( $group ) {
4834 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4843 if ( empty( $wgAddGroups[$group] ) ) {
4844 // Don't add anything to $groups
4845 } elseif ( $wgAddGroups[$group] === true ) {
4846 // You get everything
4847 $groups['add'] = self
::getAllGroups();
4848 } elseif ( is_array( $wgAddGroups[$group] ) ) {
4849 $groups['add'] = $wgAddGroups[$group];
4852 // Same thing for remove
4853 if ( empty( $wgRemoveGroups[$group] ) ) {
4855 } elseif ( $wgRemoveGroups[$group] === true ) {
4856 $groups['remove'] = self
::getAllGroups();
4857 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4858 $groups['remove'] = $wgRemoveGroups[$group];
4861 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4862 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
4863 foreach ( $wgGroupsAddToSelf as $key => $value ) {
4864 if ( is_int( $key ) ) {
4865 $wgGroupsAddToSelf['user'][] = $value;
4870 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
4871 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4872 if ( is_int( $key ) ) {
4873 $wgGroupsRemoveFromSelf['user'][] = $value;
4878 // Now figure out what groups the user can add to him/herself
4879 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
4881 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
4882 // No idea WHY this would be used, but it's there
4883 $groups['add-self'] = User
::getAllGroups();
4884 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4885 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4888 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4890 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4891 $groups['remove-self'] = User
::getAllGroups();
4892 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4893 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4900 * Returns an array of groups that this user can add and remove
4901 * @return array Array( 'add' => array( addablegroups ),
4902 * 'remove' => array( removablegroups ),
4903 * 'add-self' => array( addablegroups to self),
4904 * 'remove-self' => array( removable groups from self) )
4906 public function changeableGroups() {
4907 if ( $this->isAllowed( 'userrights' ) ) {
4908 // This group gives the right to modify everything (reverse-
4909 // compatibility with old "userrights lets you change
4911 // Using array_merge to make the groups reindexed
4912 $all = array_merge( User
::getAllGroups() );
4921 // Okay, it's not so simple, we will have to go through the arrays
4928 $addergroups = $this->getEffectiveGroups();
4930 foreach ( $addergroups as $addergroup ) {
4931 $groups = array_merge_recursive(
4932 $groups, $this->changeableByGroup( $addergroup )
4934 $groups['add'] = array_unique( $groups['add'] );
4935 $groups['remove'] = array_unique( $groups['remove'] );
4936 $groups['add-self'] = array_unique( $groups['add-self'] );
4937 $groups['remove-self'] = array_unique( $groups['remove-self'] );
4943 * Deferred version of incEditCountImmediate()
4945 public function incEditCount() {
4946 wfGetDB( DB_MASTER
)->onTransactionPreCommitOrIdle(
4948 $this->incEditCountImmediate();
4955 * Increment the user's edit-count field.
4956 * Will have no effect for anonymous users.
4959 public function incEditCountImmediate() {
4960 if ( $this->isAnon() ) {
4964 $dbw = wfGetDB( DB_MASTER
);
4965 // No rows will be "affected" if user_editcount is NULL
4968 [ 'user_editcount=user_editcount+1' ],
4969 [ 'user_id' => $this->getId(), 'user_editcount IS NOT NULL' ],
4972 // Lazy initialization check...
4973 if ( $dbw->affectedRows() == 0 ) {
4974 // Now here's a goddamn hack...
4975 $dbr = wfGetDB( DB_REPLICA
);
4976 if ( $dbr !== $dbw ) {
4977 // If we actually have a replica DB server, the count is
4978 // at least one behind because the current transaction
4979 // has not been committed and replicated.
4980 $this->mEditCount
= $this->initEditCount( 1 );
4982 // But if DB_REPLICA is selecting the master, then the
4983 // count we just read includes the revision that was
4984 // just added in the working transaction.
4985 $this->mEditCount
= $this->initEditCount();
4988 if ( $this->mEditCount
=== null ) {
4989 $this->getEditCount();
4990 $dbr = wfGetDB( DB_REPLICA
);
4991 $this->mEditCount +
= ( $dbr !== $dbw ) ?
1 : 0;
4993 $this->mEditCount++
;
4996 // Edit count in user cache too
4997 $this->invalidateCache();
5001 * Initialize user_editcount from data out of the revision table
5003 * @param int $add Edits to add to the count from the revision table
5004 * @return int Number of edits
5006 protected function initEditCount( $add = 0 ) {
5007 // Pull from a replica DB to be less cruel to servers
5008 // Accuracy isn't the point anyway here
5009 $dbr = wfGetDB( DB_REPLICA
);
5010 $count = (int)$dbr->selectField(
5013 [ 'rev_user' => $this->getId() ],
5016 $count = $count +
$add;
5018 $dbw = wfGetDB( DB_MASTER
);
5021 [ 'user_editcount' => $count ],
5022 [ 'user_id' => $this->getId() ],
5030 * Get the description of a given right
5033 * @param string $right Right to query
5034 * @return string Localized description of the right
5036 public static function getRightDescription( $right ) {
5037 $key = "right-$right";
5038 $msg = wfMessage( $key );
5039 return $msg->isDisabled() ?
$right : $msg->text();
5043 * Get the name of a given grant
5046 * @param string $grant Grant to query
5047 * @return string Localized name of the grant
5049 public static function getGrantName( $grant ) {
5050 $key = "grant-$grant";
5051 $msg = wfMessage( $key );
5052 return $msg->isDisabled() ?
$grant : $msg->text();
5056 * Make a new-style password hash
5058 * @param string $password Plain-text password
5059 * @param bool|string $salt Optional salt, may be random or the user ID.
5060 * If unspecified or false, will generate one automatically
5061 * @return string Password hash
5062 * @deprecated since 1.24, use Password class
5064 public static function crypt( $password, $salt = false ) {
5065 wfDeprecated( __METHOD__
, '1.24' );
5066 $passwordFactory = new PasswordFactory();
5067 $passwordFactory->init( RequestContext
::getMain()->getConfig() );
5068 $hash = $passwordFactory->newFromPlaintext( $password );
5069 return $hash->toString();
5073 * Compare a password hash with a plain-text password. Requires the user
5074 * ID if there's a chance that the hash is an old-style hash.
5076 * @param string $hash Password hash
5077 * @param string $password Plain-text password to compare
5078 * @param string|bool $userId User ID for old-style password salt
5081 * @deprecated since 1.24, use Password class
5083 public static function comparePasswords( $hash, $password, $userId = false ) {
5084 wfDeprecated( __METHOD__
, '1.24' );
5086 // Check for *really* old password hashes that don't even have a type
5087 // The old hash format was just an md5 hex hash, with no type information
5088 if ( preg_match( '/^[0-9a-f]{32}$/', $hash ) ) {
5089 global $wgPasswordSalt;
5090 if ( $wgPasswordSalt ) {
5091 $password = ":B:{$userId}:{$hash}";
5093 $password = ":A:{$hash}";
5097 $passwordFactory = new PasswordFactory();
5098 $passwordFactory->init( RequestContext
::getMain()->getConfig() );
5099 $hash = $passwordFactory->newFromCiphertext( $hash );
5100 return $hash->equals( $password );
5104 * Add a newuser log entry for this user.
5105 * Before 1.19 the return value was always true.
5107 * @deprecated since 1.27, AuthManager handles logging
5108 * @param string|bool $action Account creation type.
5109 * - String, one of the following values:
5110 * - 'create' for an anonymous user creating an account for himself.
5111 * This will force the action's performer to be the created user itself,
5112 * no matter the value of $wgUser
5113 * - 'create2' for a logged in user creating an account for someone else
5114 * - 'byemail' when the created user will receive its password by e-mail
5115 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5116 * - Boolean means whether the account was created by e-mail (deprecated):
5117 * - true will be converted to 'byemail'
5118 * - false will be converted to 'create' if this object is the same as
5119 * $wgUser and to 'create2' otherwise
5120 * @param string $reason User supplied reason
5123 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5124 return true; // disabled
5128 * Add an autocreate newuser log entry for this user
5129 * Used by things like CentralAuth and perhaps other authplugins.
5130 * Consider calling addNewUserLogEntry() directly instead.
5132 * @deprecated since 1.27, AuthManager handles logging
5135 public function addNewUserLogEntryAutoCreate() {
5136 $this->addNewUserLogEntry( 'autocreate' );
5142 * Load the user options either from cache, the database or an array
5144 * @param array $data Rows for the current user out of the user_properties table
5146 protected function loadOptions( $data = null ) {
5151 if ( $this->mOptionsLoaded
) {
5155 $this->mOptions
= self
::getDefaultOptions();
5157 if ( !$this->getId() ) {
5158 // For unlogged-in users, load language/variant options from request.
5159 // There's no need to do it for logged-in users: they can set preferences,
5160 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5161 // so don't override user's choice (especially when the user chooses site default).
5162 $variant = $wgContLang->getDefaultVariant();
5163 $this->mOptions
['variant'] = $variant;
5164 $this->mOptions
['language'] = $variant;
5165 $this->mOptionsLoaded
= true;
5169 // Maybe load from the object
5170 if ( !is_null( $this->mOptionOverrides
) ) {
5171 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5172 foreach ( $this->mOptionOverrides
as $key => $value ) {
5173 $this->mOptions
[$key] = $value;
5176 if ( !is_array( $data ) ) {
5177 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5178 // Load from database
5179 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5180 ?
wfGetDB( DB_MASTER
)
5181 : wfGetDB( DB_REPLICA
);
5183 $res = $dbr->select(
5185 [ 'up_property', 'up_value' ],
5186 [ 'up_user' => $this->getId() ],
5190 $this->mOptionOverrides
= [];
5192 foreach ( $res as $row ) {
5193 $data[$row->up_property
] = $row->up_value
;
5196 foreach ( $data as $property => $value ) {
5197 $this->mOptionOverrides
[$property] = $value;
5198 $this->mOptions
[$property] = $value;
5202 $this->mOptionsLoaded
= true;
5204 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5208 * Saves the non-default options for this user, as previously set e.g. via
5209 * setOption(), in the database's "user_properties" (preferences) table.
5210 * Usually used via saveSettings().
5212 protected function saveOptions() {
5213 $this->loadOptions();
5215 // Not using getOptions(), to keep hidden preferences in database
5216 $saveOptions = $this->mOptions
;
5218 // Allow hooks to abort, for instance to save to a global profile.
5219 // Reset options to default state before saving.
5220 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5224 $userId = $this->getId();
5226 $insert_rows = []; // all the new preference rows
5227 foreach ( $saveOptions as $key => $value ) {
5228 // Don't bother storing default values
5229 $defaultOption = self
::getDefaultOption( $key );
5230 if ( ( $defaultOption === null && $value !== false && $value !== null )
5231 ||
$value != $defaultOption
5234 'up_user' => $userId,
5235 'up_property' => $key,
5236 'up_value' => $value,
5241 $dbw = wfGetDB( DB_MASTER
);
5243 $res = $dbw->select( 'user_properties',
5244 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5246 // Find prior rows that need to be removed or updated. These rows will
5247 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5249 foreach ( $res as $row ) {
5250 if ( !isset( $saveOptions[$row->up_property
] )
5251 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5253 $keysDelete[] = $row->up_property
;
5257 if ( count( $keysDelete ) ) {
5258 // Do the DELETE by PRIMARY KEY for prior rows.
5259 // In the past a very large portion of calls to this function are for setting
5260 // 'rememberpassword' for new accounts (a preference that has since been removed).
5261 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5262 // caused gap locks on [max user ID,+infinity) which caused high contention since
5263 // updates would pile up on each other as they are for higher (newer) user IDs.
5264 // It might not be necessary these days, but it shouldn't hurt either.
5265 $dbw->delete( 'user_properties',
5266 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5268 // Insert the new preference rows
5269 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5273 * Lazily instantiate and return a factory object for making passwords
5275 * @deprecated since 1.27, create a PasswordFactory directly instead
5276 * @return PasswordFactory
5278 public static function getPasswordFactory() {
5279 wfDeprecated( __METHOD__
, '1.27' );
5280 $ret = new PasswordFactory();
5281 $ret->init( RequestContext
::getMain()->getConfig() );
5286 * Provide an array of HTML5 attributes to put on an input element
5287 * intended for the user to enter a new password. This may include
5288 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
5290 * Do *not* use this when asking the user to enter his current password!
5291 * Regardless of configuration, users may have invalid passwords for whatever
5292 * reason (e.g., they were set before requirements were tightened up).
5293 * Only use it when asking for a new password, like on account creation or
5296 * Obviously, you still need to do server-side checking.
5298 * NOTE: A combination of bugs in various browsers means that this function
5299 * actually just returns array() unconditionally at the moment. May as
5300 * well keep it around for when the browser bugs get fixed, though.
5302 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
5304 * @deprecated since 1.27
5305 * @return array Array of HTML attributes suitable for feeding to
5306 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
5307 * That will get confused by the boolean attribute syntax used.)
5309 public static function passwordChangeInputAttribs() {
5310 global $wgMinimalPasswordLength;
5312 if ( $wgMinimalPasswordLength == 0 ) {
5316 # Note that the pattern requirement will always be satisfied if the
5317 # input is empty, so we need required in all cases.
5319 # @todo FIXME: Bug 23769: This needs to not claim the password is required
5320 # if e-mail confirmation is being used. Since HTML5 input validation
5321 # is b0rked anyway in some browsers, just return nothing. When it's
5322 # re-enabled, fix this code to not output required for e-mail
5324 # $ret = array( 'required' );
5327 # We can't actually do this right now, because Opera 9.6 will print out
5328 # the entered password visibly in its error message! When other
5329 # browsers add support for this attribute, or Opera fixes its support,
5330 # we can add support with a version check to avoid doing this on Opera
5331 # versions where it will be a problem. Reported to Opera as
5332 # DSK-262266, but they don't have a public bug tracker for us to follow.
5334 if ( $wgMinimalPasswordLength > 1 ) {
5335 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
5336 $ret['title'] = wfMessage( 'passwordtooshort' )
5337 ->numParams( $wgMinimalPasswordLength )->text();
5345 * Return the list of user fields that should be selected to create
5346 * a new user object.
5349 public static function selectFields() {
5357 'user_email_authenticated',
5359 'user_email_token_expires',
5360 'user_registration',
5366 * Factory function for fatal permission-denied errors
5369 * @param string $permission User right required
5372 static function newFatalPermissionDeniedStatus( $permission ) {
5375 $groups = array_map(
5376 [ 'User', 'makeGroupLinkWiki' ],
5377 User
::getGroupsWithPermission( $permission )
5381 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5383 return Status
::newFatal( 'badaccess-group0' );
5388 * Get a new instance of this user that was loaded from the master via a locking read
5390 * Use this instead of the main context User when updating that user. This avoids races
5391 * where that user was loaded from a replica DB or even the master but without proper locks.
5393 * @return User|null Returns null if the user was not found in the DB
5396 public function getInstanceForUpdate() {
5397 if ( !$this->getId() ) {
5398 return null; // anon
5401 $user = self
::newFromId( $this->getId() );
5402 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5410 * Checks if two user objects point to the same user.
5416 public function equals( User
$user ) {
5417 return $this->getName() === $user->getName();